TAG LINE
SMALL TITLE

Locale

(API Version v4)


System defined list of global Locale identifiers.


What can you do with Locale?


Properties

Property Details
identity
READ-ONLY
"identity": 13
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": 3
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": 19
Type: Number
Unused
localeIdentifier
READ-ONLY
"localeIdentifier": "EN"
Type: String
System defined standard identifier for the locale.


End Points

DELETEapi/v4/Locale/{id}
Delete an instance of the Locale object. Upon successful delete, this API will return a record of all of the reelated 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 api/v4/Locale/{id}
View Sample Response
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"
            }
        ]
    }
}
GETapi/v4/Locale/
Retrieve all of the Locale objects.
Retrieve all of the Locale objects.
GET api/v4/Locale/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "English",
            "ownerId": 12,
            "ownerName": "Sample Text Data",
            "sortOrder": 21,
            "localeIdentifier": "EN"
        }
    ]
}
GETapi/v4/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 api/v4/Locale/Paged
View Sample Response
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": 24,
                "ownerName": "Sample Text Data",
                "sortOrder": 19,
                "localeIdentifier": "EN"
            }
        ]
    }
}
GETapi/v4/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 api/v4/Locale/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "English",
        "ownerId": 24,
        "ownerName": "Sample Text Data",
        "sortOrder": 11,
        "localeIdentifier": "EN"
    }
}
POSTapi/v4/Locale/
Create a new instance of the Locale object.
Create a new instance of the Locale object.
POST api/v4/Locale/

{}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "English",
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "sortOrder": 11,
                "localeIdentifier": "EN"
            }
        ]
    }
}
POSTapi/v4/Locale/Search
Retreive a list of Locale objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of Locale objects based on search criteria.
POST api/v4/Locale/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "English",
            "ownerId": 4,
            "ownerName": "Sample Text Data",
            "sortOrder": 18,
            "localeIdentifier": "EN"
        }
    ]
}
PUTapi/v4/Locale/{id}
Update an existing instance of the Locale object.
Update an existing instance of the Locale object.
PUT api/v4/Locale/{id}

{
    "identity": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "English",
                "ownerId": 22,
                "ownerName": "Sample Text Data",
                "sortOrder": 15,
                "localeIdentifier": "EN"
            }
        ]
    }
}