Jump to

• Request
• Response
• Examples

Get a worker phone

get

/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}

Request

Path Parameters

• PhoneId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• workersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Workers resource and used to uniquely identify an instance of Workers. The client should not generate the hash key value. Instead, the client should query on the Workers collection resource in order to navigate to a specific instance of Workers to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : workers-phones-item-response

Type: object

Show Source

• AreaCode: string
  Title: Area Code

  Maximum Length: 30

  Area code of the phone number.
• CountryCodeNumber: string
  Title: Country Code

  Maximum Length: 30

  Country code of the phone number. Valid values are defined in the hcmCountriesLov.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the phone information.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the phone information was created.
• Extension: string
  Title: Extension

  Maximum Length: 60

  Extension number for the phone.
• FromDate: string (date)
  Title: From Date

  Date from when the phone number is valid.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the phone information was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the phone information.
• LegislationCode: string
  Title: Country

  Maximum Length: 4

  Phone legislation code.
• LegislationName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Name of the person's legislation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneId: integer (int64)
  Title: Phone ID

  Read Only: true

  Surrogate identifier for the phone.
• PhoneNumber: string
  Title: Number

  Maximum Length: 60

  Phone number of various phone types such as Work, Home, and so on.
• phonesDFF: array phonesDFF
• PhoneType: string
  Title: Type

  Maximum Length: 30

  Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
• PhoneTypeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  Meaning of the person's phone type.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 255

  Indicates whether the phone number is the primary phone of the worker.
• ToDate: string (date)
  Title: To Date

  Date until when the phone number is valid.
• Validity: string
  Title: Validity

  Maximum Length: 30

  Time of day when a person can be reached at a specific phone number.
• ValidityMeaning: string
  Title: Validity

  Read Only: true

  Maximum Length: 80

  Description of the phone validity. Valid values are defined in the commonLookupsLOV.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the phone information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the phone information was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the phone information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":4,
            "type":"string",
            "description":"Phone legislation code.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the phone number is the primary phone of the worker.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CountryCodeNumber":{
            "title":"Country Code",
            "maxLength":30,
            "type":"string",
            "description":"Country code of the phone number. Valid values are defined in the hcmCountriesLov.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PhoneTypeMeaning":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the person's phone type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidityMeaning":{
            "title":"Validity",
            "maxLength":80,
            "type":"string",
            "description":"Description of the phone validity. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "phonesDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/workers-phones-phonesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Extension":{
            "title":"Extension",
            "maxLength":60,
            "type":"string",
            "description":"Extension number for the phone.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Validity":{
            "title":"Validity",
            "maxLength":30,
            "type":"string",
            "description":"Time of day when a person can be reached at a specific phone number.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "description":"Surrogate identifier for the phone.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "LegislationCode"
                ]
            },
            "x-queryable":true
        },
        "AreaCode":{
            "title":"Area Code",
            "maxLength":30,
            "type":"string",
            "description":"Area code of the phone number.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Number",
            "maxLength":60,
            "type":"string",
            "description":"Phone number of various phone types such as Work, Home, and so on.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"Date from when the phone number is valid.",
            "format":"date",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"Date until when the phone number is valid.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LegislationName":{
            "title":"Country",
            "maxLength":80,
            "type":"string",
            "description":"Name of the person's legislation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the phone information was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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 : phonesDFF

Type: array

Show Source

• Array of: object workers-phones-phonesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/workers-phones-phonesDFF-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 : workers-phones-phonesDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhoneId: integer (int64)
  Title: Phone ID

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhoneId":{
            "title":"Phone ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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":"HIDDEN"
            },
            "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":{
                "DISPLAYHINT":"Hide",
                "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":"HIDDEN"
            },
            "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"
    }
}

Links

legislationCodesLov

Operation: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov

The hcmCountriesLov resource includes the list of values for countries.

phoneTypesLov

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{PhoneType}%2CLookupType%3DPHONE_TYPE%2CLegislationCode%3D{LegislationCode}

The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.

phonesDFF

Operation: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF

Parameters:

• PhoneId: $request.path.PhoneId
• workersUniqID: $request.path.workersUniqID

validityLovVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LegislationCodeFinder%3BLookupCode%3D{Validity}%2CLookupType%3DPER_CONTACT_TIMES%2CLegislationCode%3D{LegislationCode}

The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.

Back to Top

Examples

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

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/workers/00020000000EACED0005770800005AF3116303090000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016ABDF0400078/child/phones/300100187109511"

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

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

{
    "PhoneId": 300100187109511,
    "PhoneType": "H1",
    "LegislationCode": "LR",
    "CountryCodeNumber": "231",
    "AreaCode": null,
    "PhoneNumber": "7543010",
    "Extension": null,
    "FromDate": "2019-05-16",
    "ToDate": null,
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T12:14:49+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T12:14:49.972+00:00",
    "PrimaryFlag": true,
    "links": [
        {...
           }
   ]
}

Back to Top