Jump to

• Request
• Response

Get all self details

get

/hcmRestApi/resources/11.13.18.05/selfDetails

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 all the self details that match the specified primary key criteria.
    Finder Variables:
• 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
• 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 : selfDetails

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object selfDetails-item-response

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

Type: object

Show Source

• AccessibilityMode: string
  Title: Accessibility Mode

  Read Only: true

  Accessibility mode, such as Default or ScreenReader.
• AccountType: string
  Title: Account Type

  Read Only: true

  Maximum Length: 255

  Type of account.
• ClientEncoding: string
  Title: Client Encoding

  Read Only: true

  Client-native encoding used for uploading, downloading, exporting, and attaching files.
• ColorContrast: string
  Title: Color Contrast

  Read Only: true

  Preferred color contrast, such as standard or high.
• Currency: string
  Title: Currency

  Read Only: true

  Currency used for the user session.
• DateFormat: string
  Title: Date Format

  Read Only: true

  Date format for the user session.
• DecimalSeparator: string
  Title: Decimal Separator

  Read Only: true

  Decimal separator for number formatting.
• DefaultLanguage: string
  Title: Default Language

  Read Only: true

  Preferred default language for the user session.
• DisplayName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 240

  Display name of the person.
• DisplayNameLanguage: string
  Title: Display Name Language

  Read Only: true

  Preferred display name language for the user session.
• EmailAddress: string
  Title: Person Email

  Read Only: true

  Maximum Length: 240

  Work email address of the person.
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of the person.
• FontSize: string
  Title: Font Size

  Read Only: true

  Preferred font size, such as large or medium.
• GroupingSeparator: string
  Title: Grouping Separator

  Read Only: true

  Grouping separator for number formatting.
• Honors: string
  Title: Honors

  Read Only: true

  Maximum Length: 80

  Qualification appended to a person's name, such as PhD.
• Initials: string
  Title: Initials

  Read Only: true

  Maximum Length: 255

  Initials of the user.
• KnownAs: string
  Title: Known As

  Read Only: true

  Maximum Length: 80

  Preferred name of the person.
• Language: string
  Title: Language

  Read Only: true

  Language used for the user session.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleNames: string
  Title: Middle Name

  Read Only: true

  Maximum Length: 80

  Middle name of the person.
• NameType: string
  Title: Name Type

  Read Only: true

  Maximum Length: 30

  Name type that's either global or local. If the record is global, it's populated with GLOBAL. If the record is local, it's populated with a legislative territory code.
• NumberFormat: string
  Title: Number Format

  Read Only: true

  Number format for the user session.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Person number of the person record linked to the user account.
• Photo: string (byte)
  Title: Photo

  Read Only: true

  Primary profile photo of the user.
• PreNameAdjunct: string
  Title: Person Name Prefix

  Read Only: true

  Maximum Length: 150

  Prefix to a person's last name.
• ServerTime: string (date-time)
  Title: Server Time

  Read Only: true

  Server time for the user session.
• Suffix: string
  Title: Suffix

  Read Only: true

  Maximum Length: 80

  Part of the name appended to a person's last name, such as Jr. for Junior or Sr. for Senior.
• Territory: string
  Title: Territory

  Read Only: true

  Territory for the user session.
• TimeFormat: string
  Title: Time Format

  Read Only: true

  Time format for the user session.
• TimeZone: string
  Title: Time Zone

  Read Only: true

  Preferred time zone of the user.
• Title: string
  Title: Title

  Read Only: true

  Maximum Length: 30

  Salutation of the person, such as Mr., and Ms.
• UserDistinguishedName: string
  Title: User Distinguished Name

  Read Only: true

  Maximum Length: 4000

  Distinguished name of the user.
• Username: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  User name of the person. This a unique identifier for a user session.

{
    "type":"object",
    "properties":{
        "PreNameAdjunct":{
            "title":"Person Name Prefix",
            "maxLength":150,
            "type":"string",
            "description":"Prefix to a person's last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Honors":{
            "title":"Honors",
            "maxLength":80,
            "type":"string",
            "description":"Qualification appended to a person's name, such as PhD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessibilityMode":{
            "title":"Accessibility Mode",
            "type":"string",
            "description":"Accessibility mode, such as Default or ScreenReader.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ColorContrast":{
            "title":"Color Contrast",
            "type":"string",
            "description":"Preferred color contrast, such as standard or high.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "KnownAs":{
            "title":"Known As",
            "maxLength":80,
            "type":"string",
            "description":"Preferred name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NameType":{
            "title":"Name Type",
            "maxLength":30,
            "type":"string",
            "description":"Name type that's either global or local. If the record is global, it's populated with GLOBAL. If the record is local, it's populated with a legislative territory code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClientEncoding":{
            "title":"Client Encoding",
            "type":"string",
            "description":"Client-native encoding used for uploading, downloading, exporting, and attaching files.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Photo":{
            "title":"Photo",
            "type":"string",
            "description":"Primary profile photo of the user.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupingSeparator":{
            "title":"Grouping Separator",
            "type":"string",
            "description":"Grouping separator for number formatting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserDistinguishedName":{
            "title":"User Distinguished Name",
            "maxLength":4000,
            "type":"string",
            "description":"Distinguished name of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Language":{
            "title":"Language",
            "type":"string",
            "description":"Language used for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency",
            "type":"string",
            "description":"Currency used for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MiddleNames":{
            "title":"Middle Name",
            "maxLength":80,
            "type":"string",
            "description":"Middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the person record linked to the user account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DecimalSeparator":{
            "title":"Decimal Separator",
            "type":"string",
            "description":"Decimal separator for number formatting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimeFormat":{
            "title":"Time Format",
            "type":"string",
            "description":"Time format for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Territory":{
            "title":"Territory",
            "type":"string",
            "description":"Territory for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultLanguage":{
            "title":"Default Language",
            "type":"string",
            "description":"Preferred default language for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":30,
            "type":"string",
            "description":"Salutation of the person, such as Mr., and Ms.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ServerTime":{
            "title":"Server Time",
            "type":"string",
            "description":"Server time for the user session.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Initials":{
            "title":"Initials",
            "maxLength":255,
            "type":"string",
            "description":"Initials of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountType":{
            "title":"Account Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Person Email",
            "maxLength":240,
            "type":"string",
            "description":"Work email address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TimeZone":{
            "title":"Time Zone",
            "type":"string",
            "description":"Preferred time zone of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Suffix":{
            "title":"Suffix",
            "maxLength":80,
            "type":"string",
            "description":"Part of the name appended to a person's last name, such as Jr. for Junior or Sr. for Senior.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"User name of the person. This a unique identifier for a user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FontSize":{
            "title":"Font Size",
            "type":"string",
            "description":"Preferred font size, such as large or medium.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DateFormat":{
            "title":"Date Format",
            "type":"string",
            "description":"Date format for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplayNameLanguage":{
            "title":"Display Name Language",
            "type":"string",
            "description":"Preferred display name language for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberFormat":{
            "title":"Number Format",
            "type":"string",
            "description":"Number format for the user session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Back to Top