Jump to

• Request
• Response

Get a territory translation

get

<servername>/api/boss/data/objects/ora/commonAppsInfra/objects/v1/territories/{territories_id}/$translations/{territories-_translations_id}

Request

Path Parameters

• territories-_translations_id(required): string
• territories_id(required): string

Query Parameters

• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.

There's no request body for this operation.

Back to Top

Response

Default Response

A single item response

Body ()

Root 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 : __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 : 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"
        }
    ]
}

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 : $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"
        }
    }
}

Links

$self

Parameters:

• territories-_translations_id: $request.path.territories-_translations_id
• territories_id: $request.path.territories_id

territory

Parameters:

• territories_id: $response.body#/territory/$id

Back to Top