Jump to

• Request
• Response
• Examples

Get all locations

get

/hcmRestApi/resources/11.13.18.05/locations

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
  
  

  • AlternateKey Finds all the locations that match the specified alternate key criteria.
    Finder Variables
    • LocationCode; string; Unique identifier for the location.
    • SetId; integer; Unique identifier of the location set.
  • PrimaryKey Unique identifier of the location's main address.
    Finder Variables
    • EffectiveEndDate; string; Third phone number of the location.
    • EffectiveStartDate; string; Second phone number of the location.
    • LocationId; integer; First phone number of the location.
  • findByLocationId Finds all the locations that match the specified location identifier.
    Finder Variables
    • LocationId; integer; Surrogate identifier for the location.
    • SysEffectiveDate; object;
• 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:
  

  • ActiveStatus; string; Reason for the action being performed on the record.
  • AddressLine1; string; First line of the location address.
  • AddressLine2; string; Second line of the location address.
  • AddressLine3; string; Third line of the location address.
  • AddressLine4; string; Fourth line of the location address.
  • AnnualWorkingDurationUnits; string; Code of the unit of the location's standard annual working duration.
  • BillToSiteFlag; boolean; Indicates whether the location is a bill to site. The default value is true.
  • Country; string; Country for the location address.
  • EffectiveEndDate; string; Effective end date of the location.
  • EffectiveStartDate; string; Effective start date of the location.
  • EmployeeLocationFlag; boolean; Indicates whether the location is an employee location. The default value is true.
  • LastUpdateDate; string; Date and time when the location record was last updated.
  • Latitude; number; Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
  • LocationCode; string; Code that uniquely references the location within the set.
  • LocationId; integer; Surrogate identifier for the location.
  • LocationName; string; Name of the location.
  • Longitude; number; Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
  • OfficeSiteFlag; boolean; Indicates whether the location is an office site. The default value is true.
  • PostalCode; string; Postal code for the location address.
  • Provider; string; Company that has validated an address.
  • ReceivingSiteFlag; boolean; Indicates whether the location is a receiving site. The default value is true.
  • Region1; string; Primary region in which the address is located. This value may be required depending on the country specified.
  • Region2; string; Secondary region withing the primary region.
  • Region3; string; Subregion within the secondary region.
  • SetId; integer; Surrogate identifier for the set to which the location belongs.
  • ShipToSiteFlag; boolean; Indicates whether the location is a ship to site. The default value is true.
  • StandardAnnualWorkingDuration; number; Standard annual working duration for the location.
  • StandardWorkingFrequency; string; Code of the frequency of the location's standard working hours.
  • StandardWorkingHours; number; Number of standard working hours for the location.
  • TownOrCity; string; Name of the Town or City for the address.
  • ValidationStatusCode; string; Level of accuracy of an address as determined by an address provider.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : locations

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/locations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object locations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/locations-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 : locations-item-response

Type: object

Show Source

• ActiveStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: A

  Reason for the action being performed on the record.
• AddressLine1: string
  Title: Address Line 1

  Maximum Length: 240

  First line of the location address.
• AddressLine2: string
  Title: Address Line 2

  Maximum Length: 240

  Second line of the location address.
• AddressLine3: string
  Title: Address Line 3

  Maximum Length: 240

  Third line of the location address.
• AddressLine4: string
  Title: Address Line 4

  Maximum Length: 240

  Fourth line of the location address.
• AnnualWorkingDurationUnits: string
  Title: Annual Working Duration Units

  Maximum Length: 10

  Code of the unit of the location's standard annual working duration.
• BillToSiteFlag: boolean
  Title: Bill-to Site

  Maximum Length: 30

  Default Value: true

  Indicates whether the location is a bill to site. The default value is true.
• Country: string
  Title: Country

  Maximum Length: 60

  Country for the location address.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the address record was created.
• Description: string
  Maximum Length: 240

  Description of the location.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Effective end date of the location.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Effective start date of the location.
• EmailAddress: string
  Title: Email

  Maximum Length: 240

  Email address for the location.
• EmployeeLocationFlag: boolean
  Title: Employee Location

  Maximum Length: 1

  Default Value: true

  Indicates whether the location is an employee location. The default value is true.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the location record was last updated.
• Latitude: number
  Title: Latitude

  Distance between the equator and an address located to its north or south, expressed in degrees and minutes.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Title: Code

  Maximum Length: 120

  Code that uniquely references the location within the set.
• LocationDFF: array LocationDFF
  Customer Flexfield for location.
• LocationId: integer (int64)
  Surrogate identifier for the location.
• LocationName: string
  Maximum Length: 60

  Name of the location.
• Longitude: number
  Title: Longitude

  Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.
• MainAddressId: integer (int64)
  Title: Main Address

  Default Value: 1

  Unique identifier of the location's main address.
• OfficeSiteFlag: boolean
  Title: Office Site

  Maximum Length: 30

  Default Value: true

  Indicates whether the location is an office site. The default value is true.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 30

  Postal code for the location address.
• Provider: string
  Title: Provider

  Maximum Length: 150

  Company that has validated an address.
• ReceivingSiteFlag: boolean
  Title: Receiving Site

  Maximum Length: 30

  Default Value: true

  Indicates whether the location is a receiving site. The default value is true.
• Region1: string
  Title: Region 1

  Maximum Length: 120

  Primary region in which the address is located. This value may be required depending on the country specified.
• Region2: string
  Title: Region 2

  Maximum Length: 120

  Secondary region withing the primary region.
• Region3: string
  Title: Region 3

  Maximum Length: 120

  Subregion within the secondary region.
• SetId: integer (int64)
  Title: Set

  Surrogate identifier for the set to which the location belongs.
• ShipToSiteFlag: boolean
  Title: Ship-to Site

  Maximum Length: 30

  Default Value: true

  Indicates whether the location is a ship to site. The default value is true.
• StandardAnnualWorkingDuration: number
  Title: Standard Annual Working Duration

  Standard annual working duration for the location.
• StandardWorkingFrequency: string
  Title: Standard Working Hours Frequency

  Maximum Length: 30

  Code of the frequency of the location's standard working hours.
• StandardWorkingHours: number
  Title: Standard Working Hours

  Number of standard working hours for the location.
• TelephoneNumber1: string
  Title: Main Phone

  Maximum Length: 240

  First phone number of the location.
• TelephoneNumber2: string
  Title: Fax

  Maximum Length: 240

  Second phone number of the location.
• TelephoneNumber3: string
  Title: Other Phone

  Maximum Length: 240

  Third phone number of the location.
• TownOrCity: string
  Title: Town or City

  Maximum Length: 60

  Name of the Town or City for the address.
• ValidationStatusCode: string
  Title: Validation Status Code

  Maximum Length: 120

  Level of accuracy of an address as determined by an address provider.

{
    "type":"object",
    "properties":{
        "StandardWorkingFrequency":{
            "title":"Standard Working Hours Frequency",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the frequency of the location's standard working hours.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the address record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "BillToSiteFlag":{
            "title":"Bill-to Site",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the location is a bill to site. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"30",
            "type":"string",
            "description":"Postal code for the location address.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"Distance between the equator and an address located to its north or south, expressed in degrees and minutes.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToSiteFlag":{
            "title":"Ship-to Site",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the location is a ship to site. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ActiveStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Reason for the action being performed on the record.",
            "nullable":false,
            "default":"A",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LocationName":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the location.",
            "nullable":false,
            "x-queryable":true
        },
        "TownOrCity":{
            "title":"Town or City",
            "maxLength":"60",
            "type":"string",
            "description":"Name of the Town or City for the address.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivingSiteFlag":{
            "title":"Receiving Site",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the location is a receiving site. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "StandardWorkingHours":{
            "title":"Standard Working Hours",
            "type":"number",
            "description":"Number of standard working hours for the location.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"3"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationDFF":{
            "type":"array",
            "description":"Customer Flexfield for location.",
            "items":{
                "$ref":"#/components/schemas/locations-LocationDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "TelephoneNumber3":{
            "title":"Other Phone",
            "maxLength":"240",
            "type":"string",
            "description":"Third phone number of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Effective end date of the location.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ValidationStatusCode":{
            "title":"Validation Status Code",
            "maxLength":"120",
            "type":"string",
            "description":"Level of accuracy of an address as determined by an address provider.",
            "nullable":true,
            "x-queryable":true
        },
        "TelephoneNumber1":{
            "title":"Main Phone",
            "maxLength":"240",
            "type":"string",
            "description":"First phone number of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "TelephoneNumber2":{
            "title":"Fax",
            "maxLength":"240",
            "type":"string",
            "description":"Second phone number of the location.",
            "nullable":true,
            "x-queryable":false
        },
        "LocationId":{
            "type":"integer",
            "description":"Surrogate identifier for the location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StandardAnnualWorkingDuration":{
            "title":"Standard Annual Working Duration",
            "type":"number",
            "description":"Standard annual working duration for the location.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"4"
            },
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Code",
            "maxLength":"120",
            "type":"string",
            "description":"Code that uniquely references the location within the set.",
            "nullable":false,
            "x-queryable":true
        },
        "Region1":{
            "title":"Region 1",
            "maxLength":"120",
            "type":"string",
            "description":"Primary region in which the address is located. This value may be required depending on the country specified.",
            "nullable":true,
            "x-queryable":true
        },
        "Region3":{
            "title":"Region 3",
            "maxLength":"120",
            "type":"string",
            "description":"Subregion within the secondary region.",
            "nullable":true,
            "x-queryable":true
        },
        "Region2":{
            "title":"Region 2",
            "maxLength":"120",
            "type":"string",
            "description":"Secondary region withing the primary region.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"Distance between the prime meridian and an address located to its east or west, expressed in degrees and minutes.",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address for the location.",
            "nullable":true,
            "x-queryable":false
        },
        "Provider":{
            "title":"Provider",
            "maxLength":"150",
            "type":"string",
            "description":"Company that has validated an address.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualWorkingDurationUnits":{
            "title":"Annual Working Duration Units",
            "maxLength":"10",
            "type":"string",
            "description":"Code of the unit of the location's standard annual working duration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressLine3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"Third line of the location address.",
            "nullable":true,
            "x-queryable":true
        },
        "MainAddressId":{
            "title":"Main Address",
            "type":"integer",
            "description":"Unique identifier of the location's main address.",
            "format":"int64",
            "nullable":false,
            "default":"1",
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"Second line of the location address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"First line of the location address.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeeLocationFlag":{
            "title":"Employee Location",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the location is an employee location. The default value is true.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AddressLine4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"Fourth line of the location address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"Country for the location address.",
            "nullable":false,
            "x-queryable":true
        },
        "OfficeSiteFlag":{
            "title":"Office Site",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the location is an office site. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "SetId":{
            "title":"Set",
            "type":"integer",
            "description":"Surrogate identifier for the set to which the location belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Effective start date of the location.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the location record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : LocationDFF

Type: array

Customer Flexfield for location.

Show Source

• Array of: object locations-LocationDFF-item-response

{
    "type":"array",
    "description":"Customer Flexfield for location.",
    "items":{
        "$ref":"#/components/schemas/locations-LocationDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : locations-LocationDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• EffectiveEndDate: string (date)
  Title: Effective End Date
• EffectiveStartDate: string (date)
  Title: Effective Start Date
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationDetailsId: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LocationDetailsId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Back to Top

Examples

The following example shows how to retrieve all the locations by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/locations"

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items": [25]
  0: {
     "LocationId": 300100072167594
     "SetId": 0
     "TelephoneNumber1": null
     "TelephoneNumber2": null
     "TelephoneNumber3": null
     "EmailAddress": null
     "ShipToSiteFlag": true
     "ReceivingSiteFlag": true
     "BillToSiteFlag": true
     "OfficeSiteFlag": true
     "LocationCode": "KV_US_LOC_FEB24_IA"
     "LocationName": "KV_US_LOC_FEB24_IA"
     "Description": null
     "MainAddressId": 300100072167597
     "AddressLine1": "Address Line 1"
     "AddressLine2": "Address Line 2"
     "AddressLine3": "Address Line 3"
     "AddressLine4": null
     "Country": "US"
     "PostalCode": "51544"
     "Region1": "CASS"
     "Region2": "IA"
     "Region3": null
     "TownOrCity": "LEWIS"
     "EffectiveStartDate": "1990-01-01"
     "EffectiveEndDate": "4712-12-31"
     "CreationDate": "2016-03-15T23:59:49-07:00"
     "LastUpdateDate": "2016-03-15T23:59:49-07:00"
     "links": [4]
	      0:  {...
         ...}
     }
  1: {
     "LocationId": 300100072167588
     "SetId": 0
     "TelephoneNumber1": null
     "TelephoneNumber2": null
     "TelephoneNumber3": null
     "EmailAddress": null
     "ShipToSiteFlag": true
     "ReceivingSiteFlag": true
     "BillToSiteFlag": true
     "OfficeSiteFlag": true
     "LocationCode": "KV_US_LOC_FEB24_VT"
     "LocationName": "KV_US_LOC_FEB24_VT"
     "Description": null
     "MainAddressId": 300100072167591
     "AddressLine1": "Address Line 1"
     "AddressLine2": "Address Line 2"
     "AddressLine3": "Address Line 3"
     "AddressLine4": null
     "Country": "US"
     "PostalCode": "05734"
     "Region1": "ADDISON"
     "Region2": "VT"
     "Region3": null
     "TownOrCity": "BRIDPORT"
     "EffectiveStartDate": "1990-01-01"
     "EffectiveEndDate": "4712-12-31"
     "CreationDate": "2016-03-15T23:59:49-07:00"
     "LastUpdateDate": "2016-03-15T23:59:49-07:00"
     "links" : [4]
        0:  {...
         ...}
}

Back to Top