Jump to

• Request
• Response

Advanced query all territories

post

<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/territories/$query

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf schema
• object type

{ "allOf":[ { "$ref":"#/components/schemas/__collection_query" }, { "type":"object", "properties":{ "parameters":{ "type":"object" } } } ] }

Nested Schema : schema

Match All

Show Source

• object schema
• object type

{ "allOf":[ { "$ref":"#/components/schemas/__item_query" }, { "type":"object", "properties":{ "collection":{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false } } } ] }

Nested Schema : schema

Type: object

Show Source

• accessors: object accessors
• fields: array fields
• subTypes: object subTypes

{ "type":"object", "properties":{ "fields":{ "type":"array", "items":{ "type":"string" } }, "subTypes":{ "type":"object" }, "accessors":{ "type":"object" } } }

Nested Schema : type

Type: object

Show Source

• collection: object collection

{ "type":"object", "properties":{ "collection":{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false } } }

Nested Schema : type

Type: object

Show Source

• parameters: object parameters

{ "type":"object", "properties":{ "parameters":{ "type":"object" } } }

Nested Schema : accessors

Type: object

Nested Schema : fields

Type: array

Show Source

• Array of: string

{ "type":"array", "items":{ "type":"string" } }

Nested Schema : subTypes

Type: object

Nested Schema : collection

Type: object

Show Source

• filter: string
• limit: integer
• offset: integer
• privilege: string
• sortBy: array sortBy

{ "type":"object", "properties":{ "filter":{ "type":"string" }, "limit":{ "type":"integer" }, "offset":{ "type":"integer" }, "sortBy":{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }, "privilege":{ "type":"string" } }, "additionalProperties":false }

Nested Schema : sortBy

Type: array

Show Source

• Array of: items

{ "type":"array", "items":{ "oneOf":[ { "type":"string" }, { "type":"object" } ] } }

Nested Schema : items

Match One Schema

Show Source

• string
• object type

{ "oneOf":[ { "type":"string" }, { "type":"object" } ] }

Nested Schema : type

Type: object

Nested Schema : parameters

Type: object

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : territories_view-default

Type: object

Show Source

• items: array items

{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/territories_view-default_item-response" } } } }

Nested Schema : items

Type: array

Show Source

• Array of: territories_view-default_item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/territories_view-default_item-response" } }

Nested Schema : territories_view-default_item-response

Match All

Show Source

• allOf territories_item-response
• object territories_view-default_item-response-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/territories_item-response" }, { "type":"object", "properties":{ "territoryCode":{ }, "territoryShortName":{ }, "description":{ }, "enabledFlag":{ }, "obsoleteFlag":{ } } } ] }

Nested Schema : territories_item-response

Match All

Show Source

• object Territory
  Title: Territory

  The territories list of values resource is used to query the ISO standard territories.
• object __busObj_context
• object territories_item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item" }, { "$ref":"#/components/schemas/__busObj_context" }, { "type":"object", "properties":{ "$translations":{ "$ref":"#/components/schemas/territories-_translations" } } } ] }

Nested Schema : Territory

Type: object

Title: Territory

The territories list of values resource is used to query the ISO standard territories.

Show Source

• $sourceLang: string
  Read Only: true
• createdBy: string
  Title: Created By

  Read Only: true

  The user who created the record.
• description: string
  Title: Territory Description

  Read Only: true

  The description of the territory.
• enabledFlag: boolean
  Title: Territory Enabled

  Read Only: true

  Indicates if a territory is enabled.
• obsoleteFlag: boolean
  Title: Territory Obsolete

  Read Only: true

  Indicates if a territory is obsolete.
• territoryCode: string
  Title: Territory Code

  Read Only: true

  The unique code of the territory.
• territoryShortName: string
  Title: Territory Short Name

  Read Only: true

  The name of the territory.
• timeCreated: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the record was created.
• timeUpdated: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• updatedBy: string
  Title: Last Updated By

  Read Only: true

  The user who last updated the record.

{ "type":"object", "properties":{ "territoryCode":{ "title":"Territory Code", "type":"string", "description":"The unique code of the territory.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "obsoleteFlag":{ "title":"Territory Obsolete", "type":"boolean", "description":"Indicates if a territory is obsolete.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "enabledFlag":{ "title":"Territory Enabled", "type":"boolean", "description":"Indicates if a territory is enabled.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "timeCreated":{ "title":"Created On", "type":"string", "format":"date-time", "description":"The date and time when the record was created.", "readOnly":true }, "createdBy":{ "title":"Created By", "type":"string", "description":"The user who created the record.", "readOnly":true }, "timeUpdated":{ "title":"Last Updated Date", "type":"string", "format":"date-time", "description":"The date and time when the record was last updated.", "readOnly":true }, "updatedBy":{ "title":"Last Updated By", "type":"string", "description":"The user who last updated the record.", "readOnly":true }, "description":{ "title":"Territory Description", "type":"string", "description":"The description of the territory.", "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "territoryShortName":{ "title":"Territory Short Name", "type":"string", "description":"The name of the territory.", "readOnly":true } }, "title":"Territory", "x-hints":{ "titlePlural":"Territories" }, "description":"The territories list of values resource is used to query the ISO standard territories.", "x-primaryKey":[ "territoryCode" ] }

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{ "type":"object", "properties":{ "$id":{ "type":"string" }, "$context":{ "type":"object", "properties":{ "etag":{ "type":"string" }, "links":{ "type":"object", "properties":{ "$self":{ "type":"object", "properties":{ "href":{ "type":"string" } } } }, "readOnly":true } } } } }

Nested Schema : territories_item-response-allOf[2]

Type: object

Show Source

• $translations: territories-_translations

{ "type":"object", "properties":{ "$translations":{ "$ref":"#/components/schemas/territories-_translations" } } }

Nested Schema : territories_view-default_item-response-allOf[1]

Type: object

Show Source

• description:
• enabledFlag:
• obsoleteFlag:
• territoryCode:
• territoryShortName:

{ "type":"object", "properties":{ "territoryCode":{ }, "territoryShortName":{ }, "description":{ }, "enabledFlag":{ }, "obsoleteFlag":{ } } }

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{ "type":"object", "properties":{ "etag":{ "type":"string" }, "links":{ "type":"object", "properties":{ "$self":{ "type":"object", "properties":{ "href":{ "type":"string" } } } }, "readOnly":true } } }

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{ "type":"object", "properties":{ "$self":{ "type":"object", "properties":{ "href":{ "type":"string" } } } }, "readOnly":true }

Nested Schema : $self

Type: object

Show Source

• href: string

{ "type":"object", "properties":{ "href":{ "type":"string" } } }

Nested Schema : territories-_translations

Match All

Show Source

• object __collection_context
• object territories-_translations-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/__collection_context" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/territories-_translations_item-response" } } } } ] }

Nested Schema : __collection_context

Type: object

Show Source

• hasMore: boolean

{ "type":"object", "properties":{ "hasMore":{ "type":"boolean" } } }

Nested Schema : territories-_translations-allOf[1]

Type: object

Show Source

• items: array items

{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/territories-_translations_item-response" } } } }

Nested Schema : items

Type: array

Show Source

• Array of: territories-_translations_item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/territories-_translations_item-response" } }

Nested Schema : territories-_translations_item-response

Match All

Show Source

• object oraCommonAppsInfraObjects.TerritoryTranslation_item
  The translation of the territory list of values resource.
• object __busObj_context

{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.TerritoryTranslation_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] }

Nested Schema : oraCommonAppsInfraObjects.TerritoryTranslation_item

Type: object

The translation of the territory list of values resource.

Show Source

• $language: string
  Read Only: true
• $sourceLang: string
  Read Only: true
• territory: territory
• territoryCode: string
  Read Only: true

  The unique code of the territory.

{ "type":"object", "properties":{ "territoryCode":{ "type":"string", "description":"The unique code of the territory.", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$language":{ "type":"string", "x-searchable":true, "x-sortable":true, "readOnly":true }, "$sourceLang":{ "type":"string", "readOnly":true }, "territory":{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] } }, "description":"The translation of the territory list of values resource.", "x-primaryKey":[ "territoryCode", "$language" ] }

Nested Schema : territory

Match All

Show Source

• object Territory
  Title: Territory

  The territories list of values resource is used to query the ISO standard territories.
• object __busObj_context

{ "allOf":[ { "$ref":"#/components/schemas/oraCommonAppsInfraObjects.Territory_item" }, { "$ref":"#/components/schemas/__busObj_context" } ] }

Back to Top