Locale

What can you do with Locale?


Properties

Property Details
id
"id": 328
Type: Number
This is the unique numeric identifier for the Locale
name
"name": "Hello World"
Type: String
ownerId
"ownerId": 369
Type: Number
Unique identifier for the associated Owner object.
sortOrder
"sortOrder": 817
Type: Number
localeIdentifier
"localeIdentifier": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • sortOrder
  • localeIdentifier

DataFlow PATCH objects:

  • locale - create, update, delete

End Points

DELETEapi/v1/Locale/{id:int}
Delete an instance of the Locale object.
GETapi/v1/Locale
Retrieve all of the Locale objects.
GETapi/v1/Locale/Metadata
Retrieve all of the meta data details of the Locale object.
GETapi/v1/Locale/Metadata/{option}
Retrieve all the meta data details of the Locale object based on provided options.
{option}Metadata options for the Locale object.
GETapi/v1/Locale/Paged
Retreive all of the Locale objects in a paged fashion.
GETapi/v1/Locale/{id:int}
Retrieve an instance of the Locale object by it's ID.
{id:int}Unique identifier for the Locale object.
POSTapi/v1/Locale
Create a new instance of the Locale object.
PUTapi/v1/Locale/{id:int}
Update an existing instance of the Locale object.