TAG LINE
TAG LINE
SMALL TITLE
Categories used to enrich mediation data.
identity READ-ONLY | "identity": 5 Type: Number This is the unique numeric identifier for the DataImportCacheCategory |
ownerId READ-ONLY | "ownerId": 16 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "Hello World" Type: String The name of the Data Import Category. |
description | "description": "Hello World" Type: String The description of the the Data Import Category. |
GET | DataImport/CacheCategory/ |
Retrieve all of the DataImportCacheCategory objects. | |
Retrieve all of the DataImportCacheCategory objects. GET DataImport/CacheCategory/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "ownerId": 6, "ownerName": "Sample Text Data", "name": "Sample Text Data", "description": "Sample Text Data" } ] } |
GET | DataImport/CacheCategory/Paged |
Retrieve all of the DataImportCacheCategory objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the DataImportCacheCategory objects in a paged fashion. GET DataImport/CacheCategory/Paged HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "ownerId": 21, "ownerName": "Sample Text Data", "name": "Sample Text Data", "description": "Sample Text Data" } ] } } |
GET | DataImport/CacheCategory/{id} |
Retrieve an instance of the DataImportCacheCategory object by its ID. | |
{id} | Unique identifier for the DataImportCacheCategory object. |
Retrieve an instance of the DataImportCacheCategory object by its ID. GET DataImport/CacheCategory/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 15, "ownerName": "Sample Text Data", "name": "Sample Text Data", "description": "Sample Text Data" } } |
POST | DataImport/CacheCategory/ |
Create a new instance of the DataImportCacheCategory object. | |
Create a new instance of the DataImportCacheCategory object. POST DataImport/CacheCategory/ { "name": "Sample Text Data", "description": "Sample Text Data" } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "ownerId": 23, "ownerName": "Sample Text Data", "name": "Sample Text Data", "description": "Sample Text Data" } ] } } |
PUT | DataImport/CacheCategory/{id} |
Update an existing instance of the DataImportCacheCategory object. | |
Update an existing instance of the DataImportCacheCategory object. PUT DataImport/CacheCategory/{id} { "identity": 1, "name": "Sample Text Data", "description": "Sample Text Data" } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "ownerId": 17, "ownerName": "Sample Text Data", "name": "Sample Text Data", "description": "Sample Text Data" } ] } } |