Jump to

• Request
• Response

Get the offer action preview

get

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/offerList/{ItemId}/child/offerActionPreviews/{ItemId4}

Request

Path Parameters

• ItemId(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=
• ItemId4(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=
• SubscriberTypeCode(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
• 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: string
  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: string
  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 : recruitingRACItems-offerList-offerActionPreviews-item-response

Type: object

Show Source

• Action: string
  Title: Action

  Read Only: true

  Maximum Length: 80

  Action performed on the selected offer.
• ActionCode: string
  Read Only: true

  Maximum Length: 30

  Action code the job offer activity item relates to.
• CandidateEmail: string
  Title: Candidate Email

  Read Only: true

  Maximum Length: 240

  Email address of the candidate that the offer is extended to.
• CandidateName: string
  Title: Candidate Name

  Read Only: true

  Maximum Length: 240

  Name of the candidate that the offer is extended to.
• CandidateNumber: string
  Title: Candidate Number

  Read Only: true

  Maximum Length: 30

  Unique identifier of the candidate.
• CandidatePhoneNumber: string
  Title: Candidate Phone Number

  Read Only: true

  Maximum Length: 240

  Phone number of the candidate that the offer is extended to.
• CurrentPhase: string
  Read Only: true

  Maximum Length: 240

  Phase of the offer in the candidate selection process.
• CurrentState: string
  Title: Offer State

  Read Only: true

  Maximum Length: 240

  State of the offer in the candidate selection process.
• DaysInThisState: integer
  Title: Days in State

  Read Only: true

  Number of days the offer has been in the current state in the candidate selection process.
• EmployeeStartDate: string (date)
  Title: Employee Start Date

  Read Only: true

  Proposed date when the candidate will begin working.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier of the action preview.
• LegalEmployer: string
  Title: Legal Employer

  Read Only: true

  Maximum Length: 240

  Legal employer of the offer.
• LegalEntityId: integer (int64)
  Read Only: true

  Legal entity ID of the offer. Might be null for some offers.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferId: integer (int64)
  Read Only: true

  Unique identifier of the offer preview.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number of the requisition associated with the offer.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Requisition title of the requisition associated with the offer.
• SubmissionId: integer (int64)
  Read Only: true

  Submission ID for the job offer action preview.
• WorkerType: string
  Title: Worker Type

  Read Only: true

  Maximum Length: 80

  Worker type the candidate will be hired as, either employee or contingent worker.

{
    "type":"object",
    "properties":{
        "CurrentPhase":{
            "maxLength":240,
            "type":"string",
            "description":"Phase of the offer in the candidate selection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Action":{
            "title":"Action",
            "maxLength":80,
            "type":"string",
            "description":"Action performed on the selected offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysInThisState":{
            "title":"Days in State",
            "type":"integer",
            "description":"Number of days the offer has been in the current state in the candidate selection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEmployer":{
            "title":"Legal Employer",
            "maxLength":240,
            "type":"string",
            "description":"Legal employer of the offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Action code the job offer activity item relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CandidateEmail":{
            "title":"Candidate Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the candidate that the offer is extended to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmployeeStartDate":{
            "title":"Employee Start Date",
            "type":"string",
            "description":"Proposed date when the candidate will begin working.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the requisition associated with the offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferId":{
            "type":"integer",
            "description":"Unique identifier of the offer preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkerType":{
            "title":"Worker Type",
            "maxLength":80,
            "type":"string",
            "description":"Worker type the candidate will be hired as, either employee or contingent worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Legal entity ID of the offer. Might be null for some offers.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrentState":{
            "title":"Offer State",
            "maxLength":240,
            "type":"string",
            "description":"State of the offer in the candidate selection process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateName":{
            "title":"Candidate Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the candidate that the offer is extended to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID for the job offer action preview.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title of the requisition associated with the offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidatePhoneNumber":{
            "title":"Candidate Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Phone number of the candidate that the offer is extended to.",
            "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