Jump to

• Request
• Response

Get all address formats of countries

get

/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the address formats for a given country using a unique ID
    Finder Variables
    • TerritoryCode; string; Finds the address formats for a given country using a unique ID and the territory code
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • TerritoryCode; string; Code assigned to the territory in the address format
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : recruitingCEAddressFormats

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEAddressFormats-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCEAddressFormats-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEAddressFormats-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCEAddressFormats-item-response

Type: object

Show Source

• addressFormatDetails: array Address Format Details
  Title: Address Format Details

  The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
• geoHierarchies: array Geographical Hierarchies
  Title: Geographical Hierarchies

  The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• stateProvinces: array State Provinces
  Title: State Provinces

  The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
• TerritoryCode: string
  Read Only: true

  Maximum Length: 255

  Code assigned to the territory in the address format

{
    "type":"object",
    "properties":{
        "TerritoryCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code assigned to the territory in the address format",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "addressFormatDetails":{
            "title":"Address Format Details",
            "type":"array",
            "description":"The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEAddressFormats-addressFormatDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "stateProvinces":{
            "title":"State Provinces",
            "type":"array",
            "description":"The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEAddressFormats-stateProvinces-item-response"
            }
        },
        "geoHierarchies":{
            "title":"Geographical Hierarchies",
            "type":"array",
            "description":"The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEAddressFormats-geoHierarchies-item-response"
            }
        }
    }
}

Nested Schema : Address Format Details

Type: array

Title: Address Format Details

The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEAddressFormats-addressFormatDetails-item-response

{
    "title":"Address Format Details",
    "type":"array",
    "description":"The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEAddressFormats-addressFormatDetails-item-response"
    }
}

Nested Schema : Geographical Hierarchies

Type: array

Title: Geographical Hierarchies

The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEAddressFormats-geoHierarchies-item-response

{
    "title":"Geographical Hierarchies",
    "type":"array",
    "description":"The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEAddressFormats-geoHierarchies-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : State Provinces

Type: array

Title: State Provinces

The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEAddressFormats-stateProvinces-item-response

{
    "title":"State Provinces",
    "type":"array",
    "description":"The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEAddressFormats-stateProvinces-item-response"
    }
}

Nested Schema : recruitingCEAddressFormats-addressFormatDetails-item-response

Type: object

Show Source

• AttributeName: string
  Read Only: true

  Maximum Length: 21

  Name assigned to the attribute to retrieve address details
• DisplaySequence: number
  Read Only: true

  Sequence in which the address is displayed
• GeographyLevel: integer (int64)
  Read Only: true

  Level of the element in the geography hierarchy.
• GeographyType: string
  Read Only: true

  Maximum Length: 30

  Geography type of the element in the geography hierarchy.
• GeographyTypeInternal: string
  Read Only: true

  Maximum Length: 30

  Internal representation of the geography type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LovColumn: string
  Read Only: true

  Maximum Length: 50

  Column with the list of values pertaining to the address details
• Maxlength: string
  Read Only: true

  Maximum Length: 30

  Column with the list of values pertaining to the address details
• Prompt: string
  Read Only: true

  Maximum Length: 80

  Prompt to assist entering the required address details
• RequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if the information is required
• TerritoryCode: string
  Read Only: true

  Maximum Length: 2

  Code assigned to the territory in the address format details
• Uidisplaytype: string
  Read Only: true

  Maximum Length: 16

  Type of display used as the user interface

{
    "type":"object",
    "properties":{
        "Uidisplaytype":{
            "maxLength":"16",
            "type":"string",
            "description":"Type of display used as the user interface",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyTypeInternal":{
            "maxLength":"30",
            "type":"string",
            "description":"Internal representation of the geography type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"number",
            "description":"Sequence in which the address is displayed",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Geography type of the element in the geography hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"Code assigned to the territory in the address format details",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Prompt":{
            "maxLength":"80",
            "type":"string",
            "description":"Prompt to assist entering the required address details",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":"21",
            "type":"string",
            "description":"Name assigned to the attribute to retrieve address details",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the information is required",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Maxlength":{
            "maxLength":"30",
            "type":"string",
            "description":"Column with the list of values pertaining to the address details",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyLevel":{
            "type":"integer",
            "description":"Level of the element in the geography hierarchy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LovColumn":{
            "maxLength":"50",
            "type":"string",
            "description":"Column with the list of values pertaining to the address details",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : recruitingCEAddressFormats-geoHierarchies-item-response

Type: object

Show Source

• DisplayName: string
  Read Only: true

  Maximum Length: 360

  Display name of the element in the geography hierarchy.
• GeoElement1: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 1 in the geographical hierarchies
• GeoElement10: string
  Title: Code

  Read Only: true

  Maximum Length: 360

  Geographical element 10 in the geographical hierarchies
• GeoElement2: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 2 in the geographical hierarchies
• GeoElement3: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 3 in the geographical hierarchies
• GeoElement4: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 4 in the geographical hierarchies
• GeoElement5: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 5 in the geographical hierarchies
• GeoElement6: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 6 in the geographical hierarchies
• GeoElement7: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 7 in the geographical hierarchies
• GeoElement8: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 8 in the geographical hierarchies
• GeoElement9: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 9 in the geographical hierarchies
• GeographyId: integer (int64)
  Read Only: true

  Geography ID for the node in the geographical hierarchy.
• GeographyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geography name of the element in the geography hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "GeoElement9":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 9 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement7":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 7 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyId":{
            "type":"integer",
            "description":"Geography ID for the node in the geographical hierarchy.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GeoElement8":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 8 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement5":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 5 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement6":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 6 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement3":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 3 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement4":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 4 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement1":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 1 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geography name of the element in the geography hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement2":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 2 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeoElement10":{
            "title":"Code",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 10 in the geographical hierarchies",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":"360",
            "type":"string",
            "description":"Display name of the element in the geography hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : recruitingCEAddressFormats-stateProvinces-item-response

Type: object

Show Source

• GeoElement2: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Geographical element 2 in the states and provinces information
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "GeoElement2":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"Geographical element 2 in the states and provinces information",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top