Jump to

• Request
• Response

Get all job offers

get

/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers

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 job offers using a primary key like OfferId; integer; , RequisitionId; integer; , and State; integer; .
    Finder Variables
    • OfferId; integer; Primary key of the job offer.
    • RequisitionId; integer; Primary key of the job requisition.
    • State; integer; Primary key of the state.
• 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:
  

  • AcceptFlag; boolean; Indicates whether the action to accept a job offer is enabled or not.
  • Action; string; Action performed on the selected job offer.
  • AssignmentId; integer; Assignment ID in the job offer being previewed.
  • BusinessUnit; string; Business unit in the job offer being previewed.
  • BusinessUnitId; integer; Business unit ID in the job offer being previewed.
  • CancelFlag; boolean; Indicates whether the cancel action on the job offer is enabled or not.
  • CandidateName; string; Candidate name in the job offer being previewed.
  • CandidateNumber; string; Candidate number in the job offer being previewed.
  • CandidateType; string; Candidate type in the job offer being previewed.
  • Code; string; Code in the job offer being previewed.
  • CreationDate; string; Job offer creation date.
  • CsdFlag; boolean; Indicates whether the action to change the start date is enabled or not.
  • Department; string; Department name in the job offer being previewed.
  • EditFlag; boolean; Indicates whether the action to edit the job offer is enabled or not.
  • EffectiveEndDate; string; Effective end date of the CandidatePEO.
  • EffectiveEndDateAsmt; string; Effective end date of the assignment.
  • EffectiveLatestChange; string; Effective last change for the assignment.
  • EffectiveSequence; integer; Effective sequence of the assignment.
  • EffectiveStartDate; string; Effective start date of the CandidatePEO.
  • EffectiveStartDateAsmt; string; Effective start date of the assignment.
  • ExtendFlag; boolean; Indicates whether the action to extend a job offer is enabled or not.
  • HireDate; string; Hire date in the job offer being previewed.
  • HiringManager; string; Hiring manager name in the job offer being previewed.
  • HiringManagerId; integer; Hiring manager ID in the job offer being previewed.
  • JobCode; string; Job code in the job offer being previewed.
  • JobId; integer; Job ID in the job offer being previewed.
  • JobName; string; Job name in the job offer being previewed.
  • LegalEmployer; string; Legal employer name in the job offer being previewed.
  • LegalEntityId; integer; Legal entity ID in the job offer being previewed.
  • LocationId; integer; Location ID in the job offer being previewed.
  • MoveFlag; boolean; Indicates whether the action to move the job offer is enabled or not.
  • MoveToHRFlag; boolean; Indicates whether the action to move the job offer to HR is enabled or not.
  • Name; string; State name in the job offer being previewed.
  • ObjectStatus; string; Object status in the job offer being previewed.
  • ObjectVersionNumber; integer; Object version number in the job offer being previewed.
  • ObjectVersionNumberAsmt; integer; Object version number for the assignment.
  • ObjectVersionNumberCand; integer; Object version number for the candidate.
  • OfferId; integer; Offer ID in the job offer being previewed.
  • OfferTitle; string; Offer title in the job offer being previewed.
  • OrganizationId; integer; Organization ID in the job offer being previewed.
  • PersonId; integer; Person ID in the job offer being previewed.
  • PersonNameId; integer; Person name ID in the job offer being previewed.
  • PositionCode; string; Position code in the job offer being previewed.
  • PositionId; integer; Position ID in the job offer being previewed.
  • PositionName; string; Position name in the job offer being previewed.
  • Recruiter; string; Recruiter name in the job offer being previewed.
  • RecruiterId; integer; Recruiter ID in the job offer being previewed.
  • RedraftFlag; boolean; Indicates whether the action to redraft the job offer is enabled or not.
  • RejectFlag; boolean; Indicates whether the action to reject the job offer is enabled or not.
  • RequisitionId; integer; Requisition ID in the job offer being previewed.
  • RequisitionNumber; string; Requisition number in the job offer being previewed.
  • State; integer; State code in the job offer being previewed.
  • StateSort; string; Sorting the status of the job offer in the list.
  • SubmissionId; integer; Submission ID in the job offer being previewed.
  • WithdrawFlag; boolean; Indicates whether the action to withdraw the job offer is enabled or not.
  • WorkLocationCity; string; Work location city in the job offer being previewed.
  • WorkLocationCountry; string; Work location country in the job offer being previewed.
  • WorkLocationName; string; Work location name in the job offer being previewed.
• 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 : recruitingUIJobOffers

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingUIJobOffers-item-response

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

Type: object

Show Source

• AcceptFlag: boolean
  Read Only: true

  Indicates whether the action to accept a job offer is enabled or not.
• Action: string
  Read Only: true

  Maximum Length: 255

  Action performed on the selected job offer.
• AssignmentId: integer (int64)
  Title: Assignment ID

  Read Only: true

  Assignment ID in the job offer being previewed.
• BusinessUnit: string
  Title: Business Unit

  Maximum Length: 255

  Business unit in the job offer being previewed.
• BusinessUnitId: integer (int64)
  Read Only: true

  Business unit ID in the job offer being previewed.
• CancelFlag: boolean
  Read Only: true

  Indicates whether the cancel action on the job offer is enabled or not.
• CandidateName: string
  Title: Candidate Name

  Read Only: true

  Maximum Length: 240

  Candidate name in the job offer being previewed.
• CandidateNumber: string
  Title: Candidate Number

  Read Only: true

  Maximum Length: 30

  Candidate number in the job offer being previewed.
• CandidateType: string
  Title: Candidate Type

  Maximum Length: 255

  Candidate type in the job offer being previewed.
• Code: string
  Read Only: true

  Maximum Length: 30

  Code in the job offer being previewed.
• CreationDate: string (date)
  Title: Offer Creation Date

  Read Only: true

  Job offer creation date.
• CsdFlag: boolean
  Read Only: true

  Indicates whether the action to change the start date is enabled or not.
• Department: string
  Title: Department

  Maximum Length: 255

  Department name in the job offer being previewed.
• EditFlag: boolean
  Read Only: true

  Indicates whether the action to edit the job offer is enabled or not.
• EffectiveEndDate: string (date)
  Read Only: true

  Effective end date of the CandidatePEO.
• EffectiveEndDateAsmt: string (date)
  Read Only: true

  Effective end date of the assignment.
• EffectiveLatestChange: string
  Title: Effective Latest Change

  Read Only: true

  Maximum Length: 30

  Effective last change for the assignment.
• EffectiveSequence: integer
  Title: Effective Sequence

  Read Only: true

  Effective sequence of the assignment.
• EffectiveStartDate: string (date)
  Read Only: true

  Effective start date of the CandidatePEO.
• EffectiveStartDateAsmt: string (date)
  Read Only: true

  Effective start date of the assignment.
• ExtendFlag: boolean
  Read Only: true

  Indicates whether the action to extend a job offer is enabled or not.
• HireDate: string (date)
  Title: Projected Start Date

  Read Only: true

  Hire date in the job offer being previewed.
• HiringManager: string
  Title: Hiring Manager

  Maximum Length: 255

  Hiring manager name in the job offer being previewed.
• HiringManagerId: integer (int64)
  Hiring manager ID in the job offer being previewed.
• JobCode: string
  Title: Job Code

  Maximum Length: 255

  Job code in the job offer being previewed.
• JobId: integer (int64)
  Read Only: true

  Job ID in the job offer being previewed.
• JobName: string
  Title: Job Name

  Maximum Length: 255

  Job name in the job offer being previewed.
• LegalEmployer: string
  Title: Legal Employer

  Maximum Length: 255

  Legal employer name in the job offer being previewed.
• LegalEntityId: integer (int64)
  Read Only: true

  Legal entity ID in the job offer being previewed.
• links: array Links
  Title: Links

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

  Location ID in the job offer being previewed.
• MoveFlag: boolean
  Read Only: true

  Indicates whether the action to move the job offer is enabled or not.
• MoveToHRFlag: boolean
  Read Only: true

  Indicates whether the action to move the job offer to HR is enabled or not.
• Name: string
  Title: State

  Read Only: true

  Maximum Length: 240

  State name in the job offer being previewed.
• ObjectStatus: string
  Maximum Length: 30

  Default Value: ORA_ACTIVE

  Object status in the job offer being previewed.
• ObjectVersionNumber: integer (int32)
  Object version number in the job offer being previewed.
• ObjectVersionNumberAsmt: integer (int32)
  Read Only: true

  Object version number for the assignment.
• ObjectVersionNumberCand: integer (int32)
  Read Only: true

  Object version number for the candidate.
• OfferId: integer (int64)
  Offer ID in the job offer being previewed.
• OfferTitle: string
  Title: Offer Name

  Maximum Length: 240

  Offer title in the job offer being previewed.
• OrganizationId: integer (int64)
  Read Only: true

  Organization ID in the job offer being previewed.
• PersonId: integer (int64)
  Title: Candidate Name

  Read Only: true

  Person ID in the job offer being previewed.
• PersonNameId: integer (int64)
  Read Only: true

  Person name ID in the job offer being previewed.
• PositionCode: string
  Title: Position Code

  Maximum Length: 255

  Position code in the job offer being previewed.
• PositionId: integer (int64)
  Read Only: true

  Position ID in the job offer being previewed.
• PositionName: string
  Title: Position Name

  Maximum Length: 255

  Position name in the job offer being previewed.
• Recruiter: string
  Title: Recruiter

  Maximum Length: 255

  Recruiter name in the job offer being previewed.
• RecruiterId: integer (int64)
  Recruiter ID in the job offer being previewed.
• RedraftFlag: boolean
  Read Only: true

  Indicates whether the action to redraft the job offer is enabled or not.
• RejectFlag: boolean
  Read Only: true

  Indicates whether the action to reject the job offer is enabled or not.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition ID in the job offer being previewed.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Requisition number in the job offer being previewed.
• State: integer (int64)
  Title: Offer State

  Read Only: true

  State code in the job offer being previewed.
• StateSort: string
  Read Only: true

  Maximum Length: 255

  Sorting the status of the job offer in the list.
• SubmissionId: integer (int64)
  Read Only: true

  Submission ID in the job offer being previewed.
• WithdrawFlag: boolean
  Read Only: true

  Indicates whether the action to withdraw the job offer is enabled or not.
• WorkLocationCity: string
  Title: Work Location City

  Maximum Length: 255

  Work location city in the job offer being previewed.
• WorkLocationCountry: string
  Title: Work Location Country

  Maximum Length: 255

  Work location country in the job offer being previewed.
• WorkLocationName: string
  Title: Work Location

  Maximum Length: 255

  Work location name in the job offer being previewed.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Offer Creation Date",
            "type":"string",
            "description":"Job offer creation date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveLatestChange":{
            "title":"Effective Latest Change",
            "maxLength":"30",
            "type":"string",
            "description":"Effective last change for the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumberAsmt":{
            "type":"integer",
            "description":"Object version number for the assignment.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"State",
            "maxLength":"240",
            "type":"string",
            "description":"State name in the job offer being previewed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferId":{
            "type":"integer",
            "description":"Offer ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveEndDateAsmt":{
            "type":"string",
            "description":"Effective end date of the assignment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"255",
            "type":"string",
            "description":"Department name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkLocationCity":{
            "title":"Work Location City",
            "maxLength":"255",
            "type":"string",
            "description":"Work location city in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveSequence":{
            "title":"Effective Sequence",
            "type":"integer",
            "description":"Effective sequence of the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HireDate":{
            "title":"Projected Start Date",
            "type":"string",
            "description":"Hire date in the job offer being previewed.",
            "format":"date",
            "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"
            }
        },
        "AcceptFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to accept a job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionCode":{
            "title":"Position Code",
            "maxLength":"255",
            "type":"string",
            "description":"Position code in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":"30",
            "type":"string",
            "description":"Candidate number in the job offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Effective end date of the CandidatePEO.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PositionName":{
            "title":"Position Name",
            "maxLength":"255",
            "type":"string",
            "description":"Position name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Business unit ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OfferTitle":{
            "title":"Offer Name",
            "maxLength":"240",
            "type":"string",
            "description":"Offer title in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "RecruiterId":{
            "type":"integer",
            "description":"Recruiter ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "maxLength":"255",
            "type":"string",
            "description":"Hiring manager name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "Code":{
            "maxLength":"30",
            "type":"string",
            "description":"Code in the job offer being previewed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RedraftFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to redraft the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateSort":{
            "maxLength":"255",
            "type":"string",
            "description":"Sorting the status of the job offer in the list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "title":"Candidate Name",
            "type":"integer",
            "description":"Person ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"Offer State",
            "type":"integer",
            "description":"State code in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"255",
            "type":"string",
            "description":"Business unit in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkLocationName":{
            "title":"Work Location",
            "maxLength":"255",
            "type":"string",
            "description":"Work location name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkLocationCountry":{
            "title":"Work Location Country",
            "maxLength":"255",
            "type":"string",
            "description":"Work location country in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "HiringManagerId":{
            "type":"integer",
            "description":"Hiring manager ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Recruiter":{
            "title":"Recruiter",
            "maxLength":"255",
            "type":"string",
            "description":"Recruiter name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Person name ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RejectFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to reject the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CsdFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to change the start date is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateType":{
            "title":"Candidate Type",
            "maxLength":"255",
            "type":"string",
            "description":"Candidate type in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumberCand":{
            "type":"integer",
            "description":"Object version number for the candidate.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action performed on the selected job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEmployer":{
            "title":"Legal Employer",
            "maxLength":"255",
            "type":"string",
            "description":"Legal employer name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "WithdrawFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to withdraw the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MoveToHRFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to move the job offer to HR is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":"255",
            "type":"string",
            "description":"Job name in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":"240",
            "type":"string",
            "description":"Requisition number in the job offer being previewed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Object status in the job offer being previewed.",
            "nullable":true,
            "default":"ORA_ACTIVE",
            "x-queryable":true
        },
        "ExtendFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to extend a job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number in the job offer being previewed.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Legal entity ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "maxLength":"255",
            "type":"string",
            "description":"Job code in the job offer being previewed.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Assignment ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Job ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PositionId":{
            "type":"integer",
            "description":"Position ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MoveFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to move the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EditFlag":{
            "type":"boolean",
            "description":"Indicates whether the action to edit the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Location ID in the job offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDateAsmt":{
            "type":"string",
            "description":"Effective start date of the assignment.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateName":{
            "title":"Candidate Name",
            "maxLength":"240",
            "type":"string",
            "description":"Candidate name in the job offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID in the job offer being previewed.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CancelFlag":{
            "type":"boolean",
            "description":"Indicates whether the cancel action on the job offer is enabled or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Effective start date of the CandidatePEO.",
            "format":"date",
            "nullable":false,
            "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."
        }
    }
}

Links

findByAdvancedSearchQuery

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/findByAdvancedSearchQuery

Creates the list of job offers based on the keyword search and provided filters.

offerAction

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/offerAction

Creates a method to perform actions on job offers like Redraft, Withdraw.

Back to Top