TAG LINE
TAG LINE
SMALL TITLE
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call. Below you will find the child objects that can be updated as part of PATCH operations for the AdministrationUser object.
Standard PATCH objects:
DataFlow PATCH objects:
| GET | Administration/User/{id} |
| Retrieve an instance of the AdministrationUser object by its ID. | |
| {id} | Unique identifier for the AdministrationUser object. |
Retrieve an instance of the AdministrationUser object by its ID. GET Administration/User/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {}
} | |
| GET | User/{userId}/LoginHistory |
| Retrieve all of the AdministrationUser objects. | |
Retrieve all of the AdministrationUser objects. GET User/{userId}/LoginHistoryHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| GET | User/{userName}/LoginHistory |
| Retrieve all of the AdministrationUser objects. | |
Retrieve all of the AdministrationUser objects. GET User/{userName}/LoginHistoryHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{}
]
} | |
| PATCH | Administration/User/{id} |
| Update or Add the AdministrationUser object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the AdministrationUser object. |
Update or Add the AdministrationUser object and optionally make changes to any child objects. PATCH Administration/User/{id}
{
"details": {},
"administrationUsers": {
"items": [
{
"patchType": "create",
"patchClientId": 1
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "administrationUser",
"instance": {}
}
]
}
} | |
| POST | Administration/User/ |
| Create a new instance of the AdministrationUser object. | |
Create a new instance of the AdministrationUser object. POST Administration/User/
{}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{}
]
}
} | |