Jump to

• Request
• Response

Get all the previous employments of the recruiting partner candidate

get

/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments

Request

Path Parameters

• CandidateToken(required): string
  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=

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 previous employments of the recruiting partner candidate using a unique ID
    Finder Variables
    • PreviousEmploymentId; integer; Finds previous employments of the recruiting partner candidate using a unique ID and the previous employer ID
• 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:
  

  • Achievements; string; Achievements in the previous employments of recruiting partner candidate.
  • AdditionalInformation; string; Additional Information in the previous employments of recruiting partner candidate.
  • BusinessType; string; Business Type in the previous employments of recruiting partner candidate.
  • City; string; City in previous employments of recruiting partner candidate.
  • CompanyURL; string; Company URL in the previous employments of recruiting partner candidate.
  • ContactSupervisorFlag; boolean; Contact Supervisor indicator in the previous employments of recruiting partner candidate.
  • Country; string; Country in previous employments of recruiting partner candidate.
  • CurrentJobFlag; boolean; Indicates the current job in the previous employments of the recruiting partner candidate.
  • Department; string; Department in the previous employments of recruiting partner candidate.
  • DirectReports; integer; Direct Reports in the previous employments of recruiting partner candidate.
  • EmployerName; string; Employer Name in the previous employments of recruiting partner candidate.
  • EmployerPhone; string; Employer phone in previous employments of recruiting partner candidate.
  • EndCompensation; number; End Compensation in the previous employments of recruiting partner candidate.
  • EndDate; string; End Date in the previous employments of recruiting partner candidate.
  • FullTimeCode; string; Full Time Code in the previous employments of recruiting partner candidate.
  • InternalFlag; boolean; Indicates an internal candidate in the previous employment of recruiting partner candidate.
  • JobFamily; string; Job Family in the previous employments of recruiting partner candidate.
  • JobFunction; string; Job Function in the previous employments of recruiting partner candidate.
  • JobTitle; string; Job Label in the previous employments of recruiting partner candidate.
  • LeavingReason; string; Leaving Reason in the previous employments of recruiting partner candidate.
  • OtherCompensation; string; Other Compensation in the previous employments of recruiting partner candidate.
  • OtherJobFunction; string; Other Job Function in the previous employments of recruiting partner candidate.
  • PreviousEmploymentId; integer; Previous Employment ID in the previous employments of recruiting partner candidate.
  • Responsibilities; string; Responsibilities in previous employments of recruiting partner candidate.
  • SectionId; integer; Section ID assigned for each section in the previous employments of recruiting partner candidate.
  • SectionName; string; Section Name assigned for each section in the previous employments of recruiting partner candidate.
  • StartCompensation; number; Start Compensation in the previous employments of recruiting partner candidate.
  • StartDate; string; Start Date in the previous employments of recruiting partner candidate.
  • StartingPosition; string; Starting Position in the previous employments of recruiting partner candidate.
  • State; string; State in previous employments of recruiting partner candidate.
  • SupervisorEmail; string; Supervisor Email in the previous employments of recruiting partner candidate.
  • SupervisorPhone; string; Supervisor Phone in the previous employments of recruiting partner candidate.
  • SupervisorTitle; string; Supervisor Label in the previous employments of recruiting partner candidate.
• 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 : recruitingPartnerCandidateDetails-previousEmployments

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/recruitingPartnerCandidateDetails-previousEmployments-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingPartnerCandidateDetails-previousEmployments-item-response

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

Type: object

Show Source

• Achievements: string (byte)
  Read Only: true

  Achievements in the previous employments of recruiting partner candidate.
• AdditionalInformation: string (byte)
  Read Only: true

  Additional Information in the previous employments of recruiting partner candidate.
• BusinessType: string
  Read Only: true

  Business Type in the previous employments of recruiting partner candidate.
• City: string
  Read Only: true

  City in previous employments of recruiting partner candidate.
• CompanyURL: string
  Read Only: true

  Company URL in the previous employments of recruiting partner candidate.
• ContactSupervisorFlag: boolean
  Read Only: true

  Contact Supervisor indicator in the previous employments of recruiting partner candidate.
• Country: string
  Read Only: true

  Country in previous employments of recruiting partner candidate.
• CurrentJobFlag: boolean
  Read Only: true

  Indicates the current job in the previous employments of the recruiting partner candidate.
• Department: string
  Read Only: true

  Department in the previous employments of recruiting partner candidate.
• DirectReports: integer
  Read Only: true

  Direct Reports in the previous employments of recruiting partner candidate.
• EmployerName: string
  Read Only: true

  Maximum Length: 255

  Employer Name in the previous employments of recruiting partner candidate.
• EmployerPhone: string
  Read Only: true

  Employer phone in previous employments of recruiting partner candidate.
• EndCompensation: number
  Read Only: true

  End Compensation in the previous employments of recruiting partner candidate.
• EndDate: string (date)
  Read Only: true

  End Date in the previous employments of recruiting partner candidate.
• FullTimeCode: string
  Read Only: true

  Full Time Code in the previous employments of recruiting partner candidate.
• InternalFlag: boolean
  Read Only: true

  Indicates an internal candidate in the previous employment of recruiting partner candidate.
• JobFamily: string
  Read Only: true

  Job Family in the previous employments of recruiting partner candidate.
• JobFunction: string
  Read Only: true

  Job Function in the previous employments of recruiting partner candidate.
• JobTitle: string
  Read Only: true

  Job Label in the previous employments of recruiting partner candidate.
• LeavingReason: string (byte)
  Read Only: true

  Leaving Reason in the previous employments of recruiting partner candidate.
• links: array Links
  Title: Links

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

  Other Compensation in the previous employments of recruiting partner candidate.
• OtherJobFunction: string
  Read Only: true

  Other Job Function in the previous employments of recruiting partner candidate.
• PreviousEmploymentId: integer
  Read Only: true

  Previous Employment ID in the previous employments of recruiting partner candidate.
• Responsibilities: string (byte)
  Read Only: true

  Responsibilities in previous employments of recruiting partner candidate.
• SectionId: integer
  Read Only: true

  Section ID assigned for each section in the previous employments of recruiting partner candidate.
• SectionName: string
  Read Only: true

  Section Name assigned for each section in the previous employments of recruiting partner candidate.
• StartCompensation: number
  Read Only: true

  Start Compensation in the previous employments of recruiting partner candidate.
• StartDate: string (date)
  Read Only: true

  Start Date in the previous employments of recruiting partner candidate.
• StartingPosition: string
  Read Only: true

  Starting Position in the previous employments of recruiting partner candidate.
• State: string
  Read Only: true

  State in previous employments of recruiting partner candidate.
• SupervisorEmail: string
  Read Only: true

  Supervisor Email in the previous employments of recruiting partner candidate.
• SupervisorName: string
  Read Only: true

  Supervisor Name in the previous employments of recruiting partner candidate.
• SupervisorPhone: string
  Read Only: true

  Supervisor Phone in the previous employments of recruiting partner candidate.
• SupervisorTitle: string
  Read Only: true

  Supervisor Label in the previous employments of recruiting partner candidate.

{
    "type":"object",
    "properties":{
        "StartingPosition":{
            "type":"string",
            "description":"Starting Position in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherJobFunction":{
            "type":"string",
            "description":"Other Job Function in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFunction":{
            "type":"string",
            "description":"Job Function in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OtherCompensation":{
            "type":"string",
            "description":"Other Compensation in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectReports":{
            "type":"integer",
            "description":"Direct Reports in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessType":{
            "type":"string",
            "description":"Business Type in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Responsibilities":{
            "type":"string",
            "description":"Responsibilities in previous employments of recruiting partner candidate.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "type":"string",
            "description":"Job Label in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupervisorPhone":{
            "type":"string",
            "description":"Supervisor Phone in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start Date in the previous employments of recruiting partner candidate.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Department":{
            "type":"string",
            "description":"Department in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactSupervisorFlag":{
            "type":"boolean",
            "description":"Contact Supervisor indicator in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompanyURL":{
            "type":"string",
            "description":"Company URL in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SectionName":{
            "type":"string",
            "description":"Section Name assigned for each section in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupervisorEmail":{
            "type":"string",
            "description":"Supervisor Email in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FullTimeCode":{
            "type":"string",
            "description":"Full Time Code in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployerPhone":{
            "type":"string",
            "description":"Employer phone in previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformation":{
            "type":"string",
            "description":"Additional Information in the previous employments of recruiting partner candidate.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartCompensation":{
            "type":"number",
            "description":"Start Compensation in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeavingReason":{
            "type":"string",
            "description":"Leaving Reason in the previous employments of recruiting partner candidate.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousEmploymentId":{
            "type":"integer",
            "description":"Previous Employment ID in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupervisorName":{
            "type":"string",
            "description":"Supervisor Name in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalFlag":{
            "type":"boolean",
            "description":"Indicates an internal candidate in the previous employment of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamily":{
            "type":"string",
            "description":"Job Family in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "type":"string",
            "description":"City in previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End Date in the previous employments of recruiting partner candidate.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupervisorTitle":{
            "type":"string",
            "description":"Supervisor Label in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Achievements":{
            "type":"string",
            "description":"Achievements in the previous employments of recruiting partner candidate.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "type":"string",
            "description":"State in previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentJobFlag":{
            "type":"boolean",
            "description":"Indicates the current job in the previous employments of the recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "type":"string",
            "description":"Country in previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID assigned for each section in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployerName":{
            "maxLength":"255",
            "type":"string",
            "description":"Employer Name in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndCompensation":{
            "type":"number",
            "description":"End Compensation in the previous employments of recruiting partner candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top