TAG LINE
TAG LINE
SMALL TITLE
System defined list of global Locale identifiers.
identity READ-ONLY | "identity": 11 Type: Number This is the unique numeric identifier for the Locale |
name READ-ONLY | "name": "English" Type: String System defined name for this Locale. |
ownerId READ-ONLY | "ownerId": 24 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. |
sortOrder READ-ONLY | "sortOrder": 27 Type: Number Unused |
localeIdentifier READ-ONLY | "localeIdentifier": "EN" Type: String System defined standard identifier for the locale. |
DELETE | Locale/{id} |
Delete an instance of the Locale object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
{id} | Unique identifier for the Locale object. |
Delete an instance of the Locale object. DELETE Locale/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "locale" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } } |
GET | Locale/ |
Retrieve all of the Locale objects. | |
Retrieve all of the Locale objects. GET Locale/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "English", "ownerId": 18, "ownerName": "Sample Text Data", "sortOrder": 19, "localeIdentifier": "EN" } ] } |
GET | Locale/Paged |
Retrieve all of the Locale 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 Locale objects in a paged fashion. GET Locale/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, "name": "English", "ownerId": 3, "ownerName": "Sample Text Data", "sortOrder": 20, "localeIdentifier": "EN" } ] } } |
GET | Locale/{id} |
Retrieve an instance of the Locale object by its ID. | |
{id} | Unique identifier for the Locale object. |
Retrieve an instance of the Locale object by its ID. GET Locale/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "English", "ownerId": 10, "ownerName": "Sample Text Data", "sortOrder": 20, "localeIdentifier": "EN" } } |
POST | Locale/ |
Create a new instance of the Locale object. | |
Create a new instance of the Locale object. POST Locale/ {} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "name": "English", "ownerId": 18, "ownerName": "Sample Text Data", "sortOrder": 8, "localeIdentifier": "EN" } ] } } |
PUT | Locale/{id} |
Update an existing instance of the Locale object. | |
Update an existing instance of the Locale object. PUT Locale/{id} { "identity": 1 } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "name": "English", "ownerId": 15, "ownerName": "Sample Text Data", "sortOrder": 20, "localeIdentifier": "EN" } ] } } |