Jump to

• Request
• Response

Get details of a job offer

get

/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}

Request

Path Parameters

• OfferId(required): integer
  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:
  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 : recruitingCEOfferDetails-item-response

Type: object

Show Source

• AcceptedOnBehalf: string
  Read Only: true

  Maximum Length: 1

  Indicates that the job offer was accepted on behalf of the candidate.
• AcceptedOnBehalfBy: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person who accepted the job offer on behalf of the candidate.
• AcceptedOnBehalfDate: string (date-time)
  Read Only: true

  Date when the job offer was accepted on behalf of the candidate.
• assignment: array Job Offer Assignment
  Title: Job Offer Assignment

  The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CandidateDisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the candidate.
• CandidateNumber: string
  Title: Candidate Number

  Read Only: true

  Maximum Length: 30

  Number of the candidate.
• Comments: string
  Title: Comments

  Read Only: true

  Maximum Length: 1000

  Necessary comments related to the job offer.
• DeclineReasonsEnabledFlag: boolean
  Read Only: true

  Maximum Length: 255

  Indicates whether or not candidates can provide comments while declining the job offer.
• Description: string
  Read Only: true

  Detailed description of the job offer provided by the offer creator.
• DisplayMode: string
  Read Only: true

  Display mode.
• ESignatureInstructions: string
  Read Only: true

  Instructions for the e-signature.
• FullName: string
  Read Only: true

  Maximum Length: 1000

  Full name of the candidate.
• HiringManagerName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the hiring manager.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• mediaLinks: array Media Links in the Job Offer
  Title: Media Links in the Job Offer

  The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.
• offerDeclineReasons: array Candidate Reasons to Decline the Job Offer
  Title: Candidate Reasons to Decline the Job Offer

  The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
• OfferId: integer (int64)
  Read Only: true

  Unique number of the job offer.
• offerLetter: array Job Offer Letter
  Title: Job Offer Letter

  The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
• OfferName: string
  Read Only: true

  Maximum Length: 240

  Name of the job offer.
• Phase: string
  Read Only: true

  Maximum Length: 240

  Phase of the job offer.
• PostAcceptMessage: string
  Read Only: true

  Maximum Length: 255

  Message shown to candidates after they accept the job offer.
• RecCandidateType: string
  Read Only: true

  Candidate type, that's external or internal.
• RequisitionNumber: string
  Title: Requisition Number

  Read Only: true

  Maximum Length: 240

  Number of the job requisition associated with the job offer.
• SignatureDate: string (date-time)
  Read Only: true

  Date when the candidate signed the job offer.
• SigneeIpAddress: string
  Read Only: true

  Maximum Length: 100

  IP address of the candidate who accepted the job offer.
• State: string
  Read Only: true

  Maximum Length: 240

  State of the job offer.
• SubmissionLanguageCode: string
  Title: Job Application Language

  Read Only: true

  Maximum Length: 4

  Code of the language used for the candidate job application.

{
    "type":"object",
    "properties":{
        "DeclineReasonsEnabledFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether or not candidates can provide comments while declining the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SubmissionsProcessTemplateId"
                ]
            },
            "x-queryable":true
        },
        "Phase":{
            "maxLength":"240",
            "type":"string",
            "description":"Phase of the job offer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Detailed description of the job offer provided by the offer creator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEOfferDetails-attachments-item-response"
            }
        },
        "RecCandidateType":{
            "type":"string",
            "description":"Candidate type, that's external or internal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionLanguageCode":{
            "title":"Job Application Language",
            "maxLength":"4",
            "type":"string",
            "description":"Code of the language used for the candidate job application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiringManagerName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the hiring manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":"240",
            "type":"string",
            "description":"Number of the job requisition associated with the job offer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferId":{
            "type":"integer",
            "description":"Unique number of the job offer.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "ESignatureInstructions":{
            "type":"string",
            "description":"Instructions for the e-signature.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateDisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostAcceptMessage":{
            "maxLength":"255",
            "type":"string",
            "description":"Message shown to candidates after they accept the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offerLetter":{
            "title":"Job Offer Letter",
            "type":"array",
            "description":"The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEOfferDetails-offerLetter-item-response"
            }
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SigneeIpAddress":{
            "maxLength":"100",
            "type":"string",
            "description":"IP address of the candidate who accepted the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"Necessary comments related to the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "assignment":{
            "title":"Job Offer Assignment",
            "type":"array",
            "description":"The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEOfferDetails-assignment-item-response"
            }
        },
        "offerDeclineReasons":{
            "title":"Candidate Reasons to Decline the Job Offer",
            "type":"array",
            "description":"The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEOfferDetails-offerDeclineReasons-item-response"
            }
        },
        "AcceptedOnBehalfBy":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person who accepted the job offer on behalf of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedOnBehalf":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job offer was accepted on behalf of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayMode":{
            "type":"string",
            "description":"Display mode.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SignatureDate":{
            "type":"string",
            "description":"Date when the candidate signed the job offer.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedOnBehalfDate":{
            "type":"string",
            "description":"Date when the job offer was accepted on behalf of the candidate.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"240",
            "type":"string",
            "description":"State of the job offer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "maxLength":"1000",
            "type":"string",
            "description":"Full name of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "mediaLinks":{
            "title":"Media Links in the Job Offer",
            "type":"array",
            "description":"The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEOfferDetails-mediaLinks-item-response"
            }
        }
    }
}

Nested Schema : Job Offer Assignment

Type: array

Title: Job Offer Assignment

The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEOfferDetails-assignment-item-response

{
    "title":"Job Offer Assignment",
    "type":"array",
    "description":"The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEOfferDetails-assignment-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object recruitingCEOfferDetails-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEOfferDetails-attachments-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 : Media Links in the Job Offer

Type: array

Title: Media Links in the Job Offer

The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEOfferDetails-mediaLinks-item-response

{
    "title":"Media Links in the Job Offer",
    "type":"array",
    "description":"The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEOfferDetails-mediaLinks-item-response"
    }
}

Nested Schema : Candidate Reasons to Decline the Job Offer

Type: array

Title: Candidate Reasons to Decline the Job Offer

The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEOfferDetails-offerDeclineReasons-item-response

{
    "title":"Candidate Reasons to Decline the Job Offer",
    "type":"array",
    "description":"The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEOfferDetails-offerDeclineReasons-item-response"
    }
}

Nested Schema : Job Offer Letter

Type: array

Title: Job Offer Letter

The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEOfferDetails-offerLetter-item-response

{
    "title":"Job Offer Letter",
    "type":"array",
    "description":"The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEOfferDetails-offerLetter-item-response"
    }
}

Nested Schema : recruitingCEOfferDetails-assignment-item-response

Type: object

Show Source

• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Name of a job assignment.
• BusinessUnitName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Name of a business unit.
• DepartmentName: string
  Title: Department

  Read Only: true

  Maximum Length: 240

  Name of a department.
• FormattedMultiLineAddress: string
  Title: Address

  Read Only: true

  Candidate's address in a multiple lines format.
• FormattedSingleLineAddress: string
  Title: Address

  Read Only: true

  Candidate's address in a single line format.
• GradeName: string
  Title: Grade

  Read Only: true

  Maximum Length: 240

  Name of the grade of job offered to the candidate.
• JobTitle: string
  Title: Job

  Read Only: true

  Maximum Length: 240

  Title of the job offered to the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationName: string
  Title: Display Name

  Read Only: true

  Maximum Length: 240

  Location of the job assignment.
• ProjectedStartDate: string (date)
  Title: Projected Start Date

  Read Only: true

  Projected start date of an assignment.
• SupervisorDisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the supervisor.

{
    "type":"object",
    "properties":{
        "FormattedSingleLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"Candidate's address in a single line format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProjectedStartDate":{
            "title":"Projected Start Date",
            "type":"string",
            "description":"Projected start date of an assignment.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GradeName":{
            "title":"Grade",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the grade of job offered to the candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedMultiLineAddress":{
            "title":"Address",
            "type":"string",
            "description":"Candidate's address in a multiple lines format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of a job assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department",
            "maxLength":"240",
            "type":"string",
            "description":"Name of a department.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupervisorDisplayName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the supervisor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"Name of a business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job",
            "maxLength":"240",
            "type":"string",
            "description":"Title of the job offered to the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationName":{
            "title":"Display Name",
            "maxLength":"240",
            "type":"string",
            "description":"Location of the job assignment.",
            "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."
        }
    }
}

Nested Schema : recruitingCEOfferDetails-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : recruitingCEOfferDetails-mediaLinks-item-response

Type: object

Show Source

• Language: string
  Read Only: true

  Maximum Length: 4

  Type of language used in the media links.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Code of the media type used in the media links.
• Priority: integer (int32)
  Read Only: true

  Priority of media links.
• ThumbURL: string
  Read Only: true

  Maximum Length: 1000

  Thumb URL of the media links.
• Title: string
  Read Only: true

  Maximum Length: 240

  Title of the media link defining the purpose of the URL.
• Type: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of media link.
• URL: string
  Read Only: true

  Maximum Length: 1000

  URL of the media link.

{
    "type":"object",
    "properties":{
        "Type":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Type of media link.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Type of language used in the media links.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ThumbURL":{
            "maxLength":"1000",
            "type":"string",
            "description":"Thumb URL of the media links.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"Priority of media links.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Title":{
            "maxLength":"240",
            "type":"string",
            "description":"Title of the media link defining the purpose of the URL.",
            "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"
            }
        },
        "URL":{
            "maxLength":"1000",
            "type":"string",
            "description":"URL of the media link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MediaTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the media type used in the media links.",
            "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 : recruitingCEOfferDetails-offerDeclineReasons-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReasonId: integer
  Read Only: true

  ID of the reason selected by candidates while declining the job offer.
• ReasonName: string
  Read Only: true

  Maximum Length: 512

  Name of the reason selected by candidates while declining the job offer.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReasonName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the reason selected by candidates while declining the job offer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReasonId":{
            "type":"integer",
            "description":"ID of the reason selected by candidates while declining the job offer.",
            "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 : recruitingCEOfferDetails-offerLetter-item-response

Type: object

Show Source

• HTML: string
  Html format of the job offer letter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OfferId: integer
  ID assigned to an offer letter.
• PDF: string
  PDF format of the job offer letter.

{
    "type":"object",
    "properties":{
        "OfferId":{
            "type":"integer",
            "description":"ID assigned to an offer letter.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HTML":{
            "type":"string",
            "description":"Html format of the job offer letter.",
            "nullable":true,
            "x-queryable":true
        },
        "PDF":{
            "type":"string",
            "description":"PDF format of the job offer letter.",
            "nullable":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"
    }
}

Links

assignment

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/assignment

Parameters:

• OfferId: $request.path.OfferId

The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.

attachments

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments

Parameters:

• OfferId: $request.path.OfferId

The attachments resource is used to view, create, and update attachments.

mediaLinks

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/mediaLinks

Parameters:

• OfferId: $request.path.OfferId

The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.

offerDeclineReasons

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerDeclineReasons

Parameters:

• OfferId: $request.path.OfferId

The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.

offerLetter

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerLetter

Parameters:

• OfferId: $request.path.OfferId

The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top