Jump to

• Request
• Response

Get all phones

get

/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones

Request

Path Parameters

• hcmContactsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the HCM Contacts resource and used to uniquely identify an instance of HCM Contacts. The client should not generate the hash key value. Instead, the client should query on the HCM Contacts collection resource in order to navigate to a specific instance of HCM Contacts 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
• 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 all the contact phones that match the specified primary key criteria.
    Finder Variables
    • PhoneId; integer; Surrogate identifier for the contact's phone.
• 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:
  

  • AreaCode; string; Area code of the contact's phone number.
  • CountryCodeNumber; string; Country code of the contact's phone number. Valid values are defined in the hcmCountriesLov.
  • Extension; string; Extension number for the contact's phone.
  • LegislationCode; string; Legislation code of the contact's phone.
  • LegislationName; string; Name of the contact's legislation.
  • PhoneId; integer; Surrogate identifier for the contact's phone.
  • PhoneNumber; string; Contact's phone number for various phone types such as Work, Home, and so on.
  • PhoneType; string; Type of phone such as Work, Home, and so on. Valid values are defined in the commonLookupsLOV.
  • PhoneTypeMeaning; string; Meaning of the contact's phone type.
  • PrimaryFlag; boolean; Indicates whether the phone number is the primary phone of the contact.
  • ToDate; string; Date until when the contact's phone number is valid.
  • Validity; string; Time of day when a person can be reached at a specific phone number.
  • ValidityMeaning; string; Description of the phone validity. Valid values are defined in the commonLookupsLOV.
• 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 : hcmContacts-phones

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/hcmContacts-phones-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object hcmContacts-phones-item-response

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

Type: object

Show Source

• AreaCode: string
  Title: Area Code

  Maximum Length: 30

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 60

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 4

  Legislation code of the contact's phone.
• LegislationName: string
  Title: Country

  Read Only: true

  Maximum Length: 80

  Name of the contact'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 contact's phone.
• PhoneNumber: string
  Title: Number

  Maximum Length: 60

  Contact's phone number for 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 contact's phone type.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 255

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

  Date until when the contact's 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 contact's 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 contact's 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 contact's phone information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":"4",
            "type":"string",
            "description":"Legislation code of the contact's phone.",
            "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 contact.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CountryCodeNumber":{
            "title":"Country Code",
            "maxLength":"30",
            "type":"string",
            "description":"Country code of the contact's 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 contact'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/hcmContacts-phones-phonesDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "Extension":{
            "title":"Extension",
            "maxLength":"60",
            "type":"string",
            "description":"Extension number for the contact's 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 contact's 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 contact's phone number.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Number",
            "maxLength":"60",
            "type":"string",
            "description":"Contact's phone number for 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 contact's 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 contact's 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 contact's legislation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the contact's 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 hcmContacts-phones-phonesDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/hcmContacts-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 : hcmContacts-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"
    }
}

Back to Top