Skip to main content
Version: 1.004.000

Read

GET​

GET resource ById​

To read a resource by key, you need to perform a GET request specifying the id/key:

  • Configure the HTTP request as GET.

The response consists of:

  • status: 200.
  • headers: information about the response.
  • body: the actual content of the response, in JSON format.

GET: e.g. tse.smart-api.teamsystem.cloud/api/{product}/{version}/company/{defaultCompany}/{module}/{resource}/{id}

Parameters​

  • id: identifier code of the resource to read

Response Codes​

  • 200: the requested {resource}DTO object
  • 404: if the object was not found

GET resources​

To read all records of a resource, simply call the service.

  • Configure the HTTP request as GET.

The response consists of:

  • status: 200.
  • headers: information about the response.
  • body: the actual content of the response, in JSON format as an array of the resource.

GET: tse.smart-api.teamsystem.cloud/api/{product}/v1/company/{defaultCompany}/{module}/{resources}

javascript
curl -X 'GET' \
  'https://tse.smart-api.teamsystem.cloud/api/tse10/v1/company/1/document/orders?fields=document-id%2Cregistry-date%2Cdocument-number%2Cdocument-date&document-number=00001&registration-number=202100000128&document-date=2025-10-10&section  'https://tse.smart-api.teamsystem.cloud/api/tse10/v1/company/1/document/orders?fields=document-id%2Cregistry-date%2Cdocument-number%2Cdocument-date&document-number=00001&registration-number=202100000128&document-date=2025-10-10&sectional=00&pagecount=5&pageposition=0&orderby=document-number&user=admin' \
  -H 'accept: application/json' \
  -H 'accept-language: it-IT'

Parameters​

$filter: An OData expression using the entity's fields to retrieve a subset of the results. For more details on how to use the language, see Link.

warning

L'implementazione dei filtri OData ad oggi suppor i seguenti operatiori: The implementation of OData filters currently supports the following operators:

  • eq - equal: $filter=fieldname eq xxxxxx;
  • ne - not equal: $filter=fieldname ne xxxxxx;
  • gt - greater than: $filter=fieldname gt xxxxxx)
  • ge - greater than or equal: $filter=fieldname ge xxxxxx;
  • lt - less than: $filter=fieldname lt xxxxxx;
  • le - less than or equal: $filter=fieldname le xxxxxx;
  • and - logical and: $filter=condition1 and condition2;
  • or - logical or: $filter=condition1 or condition2;
  • not - logical not: $filter=not condition;
  • contains() - contains: $filter=contains(fieldname, 'value');
  • startswith() - starts with: $filter=startswith(fieldname, 'value');
  • endwith() - ends with: $filter=endwith(fieldname, 'value');

Response Codes​

  • 200: the requested {resource}DTO object
  • 404: if the object was not found