...
Since the response may vary depending on the state of the data, the query parameters, the resource configuration, and the data model, a response is presented here that may be somewhat different from what you will get in your implementation. Not all sections are documented here for the same reasons. The debug sections in particular are not documented on this page.
| Code Block |
|---|
{
"response": {
"data": [
"activated",
"adeoproduct",
"aicelebrity",
"aicolor",
"ailandmark",
"allproperties",
"asset",
"assetauthor",
"assetchannel",
"assetcolorspace",
"assetcoverage",
"assetformat",
"assetgeography",
"assetiaconcept",
"assetkeyword",
"assetnature",
"assetrighttype",
"assetseason",
"assettest",
"assetvisibility",
"brandcenter",
"color",
"cspsource",
"externalvideo",
"folder",
"frontmainsearch",
"lang",
"legacy",
"mediagroup",
"micthesaurus",
"organization",
"pimasset",
"pimassettype",
"pkgroletemplate",
"product",
"productcategory",
"resort",
"reversesearch",
"reversesearchdomain",
"reversesearchmatch",
"reversesearchpage",
"role",
"user",
"userregistration",
"usertype",
"videoratio",
"wkfasset",
"wkfsys",
"wkfuser",
"workflow"
],
"total": 50,
"count": 50
},
"version": "1.0",
"apiversion": "2.4"
} |
Response
This documentation describes all the exposable properties. The documentation of the API (ReDoc or SwaggerUI) of the usage environment is more specific to the environment and will detail the information actually exposed on it.
JSON Path The path to the property | Type* Type of information | JSON Type The type of the value | Description The description of the value | Presence When this property is exposed | Comment |
|---|---|---|---|---|---|
$ | STRUCT | Object | The response for end point invocation (root) | Always |
|
$.response | STRUCT | Object | Data specific to the call for service response | Always |
|
$.version | TECH | String | Version of the API end point | Always | |
$.apiversion | TECH | String | Version of the API | Always | |
$.response.data | STRUCT | Array of strings | List of resource names | Always | |
$.response.total | AGPG | Number | The total number of resource corresponding to the request | ||
$.response.count | AGPG | Number | The number of resource names in this response |
The property type classifies properties into 6 types:
DATA: the data properties of the resource, such as its name, its metadata...
TECH: related technical properties, such as the URL of the preview, or the description of the workflow
STRUCT: structural data of the JSON response, such as the hateoas link section, the header description
META: metadata about the type of resource, such as its name or description
AGPG: aggregate or pagination metadata (counters, page numbers, etc), HATEOAS, etc
OTHERS: other