Get the list of Entities

AppZen

Updated On: July 13, 2023 11:46

Fetches the list of all the Entities and their uuids that are filtered by the search criteria specified.
The search is based on 'from-date' and 'end-date'.

Request URI

POST https://api.appzen.com/dictionary-data-services/
     entity/search

Header Parameters

Name	Type	Description	Required
x-api-key	String	The x-api-key provided to authorize the request.	Yes
customer-id	String	The Customer ID provided to authorize the request.	Yes
customer-key	String	The Customer Key provided to authorize the request.	Yes

Body Parameters

Name	Type	Description	Required
from-last-appzen-update-time	String	The Start Date value. The Date should be in UTC format. Example:2020-11-01T11:01:00Z	Yes
to-last-appzen-update-time	String	The End Date value.The Date should be in UTC format. Example:2020-11-01T11:01:00Z	Yes
limit	Integer	The maximum number of matched records to return. Default:1000 Maximum:1000	Yes

Sample Request

curl -X POST "https://.appzen.com/dictionary-data-services/entity/search"
  -H "accept: application/json" 
  -H "x-api-key: R7wsFxxxx" 
  -H "customer-id: 1004xxxx" 
  -H "customer-key: 15d1xxxx"
  -H "Content-Type: application/json" 
  -d "{ 
         "from-last-appzen-update-time": "2020-11-01T11:01:00Z", 
          "to-last-appzen-update-time": "2020-11-05T11:01:00Z", "limit": 0 
      }"

Sample Response

Success

[
  {
    "entity-id": "1951243072",
    "appzen-uuid": "506dd9b6-a93c-48fc-98e8-919093032b49",
    "is-active": false,
    "last-appzen-update-time": "2021-12-08T23:00:17.724Z"
  },
  {
    "entity-id": "1623599683",
    "appzen-uuid": "f43c0612-11b5-4965-9554-425fbffdda6d",
    "is-active": false,
    "last-appzen-update-time": "2021-12-08T23:30:15.368Z"
  }
]

Failure

The request fails if you enter an invalid URL.

 {
  "timestamp": "2023-01-15T16:12:45.977+0000",
  "status": 404,
  "error": "Not Found",
  "message": "Error code : 17e3338d - The resource you specified cannot be not found"
 }

Response Code

Response Code	Description
200	The request is successful.
400	The request failed due to a malformed request syntax. Check the requested URL, including the parameters.
401	The request failed due to an authorization issue. For example, the Customer Key could be missing or invalid.
403	The request failed due to a permission issue. The x-api key may not have permission to perform the request.
404	The request failed as the resource is not found. Check the requested URL.
500	The request failed due to an AppZen server issue.

See Also