Jump to

• Request
• Response

Get all offer activity items for a recruiter or hiring manager on the offer hiring team

get

/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/offerList

Request

Path Parameters

• SubscriberTypeCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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 the activity item using the specified primary key.
    Finder Variables
    • ItemId; integer; Primary key and the item ID used to find the activity item.
• 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:
  

  • ActionDate; string; Action date of an activity item.
  • Candidate; string; Name of the candidate that the activity item relates to.
  • CandidateNumber; string; Candidate number of the candidate associated with the activity item.
  • DefaultAction; string; Default action of the job offer activity item.
  • DefaultActionName; string; Name of the default action for the activity item.
  • HiringManager; string; Name of the hiring manager of the job offer for the activity item.
  • HiringManagerId; integer; Person identifier of the hiring manager associated with the activity item.
  • ItemId; integer; Unique identifier of the activity item.
  • ItemName; string; Name of the activity item.
  • ObjectId; integer; Object identifier of the activity item.
  • OfferId; integer; Offer ID of the offer related to the activity item.
  • Priority; string; Activity item priority, can be high or null.
  • PriorityCode; string; Rule priority code the job offer activity relates to.
  • Recruiter; string; Name of the recruiter of the job offer for the activity item.
  • RecruiterId; integer; Person identifier of the recruiter associated with the activity item.
  • RequisitionId; integer; Requisition identifier of the requisition associated with the activity item.
  • RequisitionNumber; string; Requisition number of the requisition associated with the activity item.
  • RequisitionTitle; string; Requisition title of the requisition associated with the activity item.
  • Subject; string; Subject associated with the job offer.
  • SubmissionId; integer; Submission ID associated with the job offer.
  • SubscriberRuleCode; string; Subscriber rule code for the activity item.
  • SubscriberRuleId; integer; Subscriber rule ID for the activity item.
  • SubscriberTypeCode; string; Subscriber type code for the activity item, in this case offer is the subscriber.
  • SubscriberTypeMeaning; string; Subscriber type meaning of the subscriber associated with the activity item.
• 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : recruitingRACItems-offerList

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/recruitingRACItems-offerList-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingRACItems-offerList-item-response

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

Type: object

Show Source

• ActionDate: string (date)
  Title: Date

  Read Only: true

  Action date of an activity item.
• actions: array Job Requisition Actions List
  Title: Job Requisition Actions List

  The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
• Candidate: string
  Title: Candidate

  Read Only: true

  Maximum Length: 240

  Name of the candidate that the activity item relates to.
• CandidateNumber: string
  Read Only: true

  Maximum Length: 30

  Candidate number of the candidate associated with the activity item.
• DefaultAction: string
  Read Only: true

  Maximum Length: 30

  Default action of the job offer activity item.
• DefaultActionName: string
  Read Only: true

  Maximum Length: 255

  Name of the default action for the activity item.
• HiringManager: string
  Title: Hiring Manager

  Read Only: true

  Maximum Length: 240

  Name of the hiring manager of the job offer for the activity item.
• HiringManagerId: integer (int64)
  Read Only: true

  Person identifier of the hiring manager associated with the activity item.
• ItemId: integer (int64)
  Read Only: true

  Unique identifier of the activity item.
• ItemName: string
  Title: Activity

  Read Only: true

  Maximum Length: 240

  Name of the activity item.
• links: array Links
  Title: Links

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

  Object identifier of the activity item.
• offerActionPreviews: array Job Offer Action Previews
  Title: Job Offer Action Previews

  The offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed.
• OfferId: integer (int64)
  Read Only: true

  Offer ID of the offer related to the activity item.
• offerPreviews: array Job Offer Preview
  Title: Job Offer Preview

  The offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 30

  Activity item priority, can be high or null.
• PriorityCode: string
  Read Only: true

  Maximum Length: 30

  Rule priority code the job offer activity relates to.
• Recruiter: string
  Read Only: true

  Maximum Length: 240

  Name of the recruiter of the job offer for the activity item.
• RecruiterId: integer (int64)
  Read Only: true

  Person identifier of the recruiter associated with the activity item.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition identifier of the requisition associated with the activity item.
• RequisitionNumber: string
  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  Requisition title of the requisition associated with the activity item.
• Subject: string
  Read Only: true

  Maximum Length: 30

  Subject associated with the job offer.
• SubmissionId: integer (int64)
  Read Only: true

  Submission ID associated with the job offer.
• SubscriberRuleCode: string
  Read Only: true

  Maximum Length: 256

  Subscriber rule code for the activity item.
• SubscriberRuleId: integer (int64)
  Read Only: true

  Subscriber rule ID for the activity item.
• SubscriberTypeCode: string
  Read Only: true

  Maximum Length: 30

  Subscriber type code for the activity item, in this case offer is the subscriber.
• SubscriberTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Subscriber type meaning of the subscriber associated with the activity item.

{
    "type":"object",
    "properties":{
        "SubscriberRuleId":{
            "type":"integer",
            "description":"Subscriber rule ID for the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriorityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Rule priority code the job offer activity relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier of the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the requisition associated with the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "title":"Date",
            "type":"string",
            "description":"Action date of an activity item.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferId":{
            "type":"integer",
            "description":"Offer ID of the offer related to the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition identifier of the requisition associated with the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberRuleCode":{
            "maxLength":256,
            "type":"string",
            "description":"Subscriber rule code for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Activity",
            "maxLength":240,
            "type":"string",
            "description":"Name of the activity item.",
            "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"
            }
        },
        "offerActionPreviews":{
            "title":"Job Offer Action Previews",
            "type":"array",
            "description":"The offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-offerList-offerActionPreviews-item-response"
            },
            "x-cardinality":"1"
        },
        "Candidate":{
            "title":"Candidate",
            "maxLength":240,
            "type":"string",
            "description":"Name of the candidate that the activity item relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Candidate number of the candidate associated with the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultActionName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the default action for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object identifier of the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"Activity item priority, can be high or null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecruiterId":{
            "type":"integer",
            "description":"Person identifier of the recruiter associated with the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HiringManager":{
            "title":"Hiring Manager",
            "maxLength":240,
            "type":"string",
            "description":"Name of the hiring manager of the job offer for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":30,
            "type":"string",
            "description":"Subject associated with the job offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriberTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Subscriber type meaning of the subscriber associated with the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offerPreviews":{
            "title":"Job Offer Preview",
            "type":"array",
            "description":"The offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-item-response"
            },
            "x-cardinality":"1"
        },
        "DefaultAction":{
            "maxLength":30,
            "type":"string",
            "description":"Default action of the job offer activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID associated with the job offer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Subscriber type code for the activity item, in this case offer is the subscriber.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiringManagerId":{
            "type":"integer",
            "description":"Person identifier of the hiring manager associated with the activity item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "actions":{
            "title":"Job Requisition Actions List",
            "type":"array",
            "description":"The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-offerList-actions-item-response"
            }
        },
        "RequisitionTitle":{
            "title":"Requisition",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title of the requisition associated with the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Recruiter":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the recruiter of the job offer for the activity item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Job Requisition Actions List

Type: array

Title: Job Requisition Actions List

The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.

Show Source

• Array of: object recruitingRACItems-offerList-actions-item-response

{
    "title":"Job Requisition Actions List",
    "type":"array",
    "description":"The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-offerList-actions-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 : Job Offer Action Previews

Type: array

Title: Job Offer Action Previews

The offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed.

Show Source

• Array of: object recruitingRACItems-offerList-offerActionPreviews-item-response

{
    "title":"Job Offer Action Previews",
    "type":"array",
    "description":"The offerActionPreviews resource is the child of the recruitingRACItems resource. It provides a preview displaying data about the offer based on the action being performed.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-offerList-offerActionPreviews-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Job Offer Preview

Type: array

Title: Job Offer Preview

The offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer.

Show Source

• Array of: object recruitingRACItems-offerList-offerPreviews-item-response

{
    "title":"Job Offer Preview",
    "type":"array",
    "description":"The offerPreview resource is the child of the recruitingRACItems resource. It provides a preview of the details of a job offer.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : recruitingRACItems-offerList-actions-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Action code the job requisition activity item relates to.
• ActionName: string
  Read Only: true

  Maximum Length: 255

  Action name the job requisition activity item relates to.
• DefaultFlag: boolean
  Maximum Length: 1

  Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Action code the job requisition activity item relates to.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionName":{
            "maxLength":255,
            "type":"string",
            "description":"Action name the job requisition activity item relates to.",
            "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"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list.",
            "nullable":false,
            "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 : recruitingRACItems-offerList-offerActionPreviews-item-response

Type: object

Show Source

• Action: string
  Title: Action

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

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

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

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

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 240

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

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

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

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

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

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

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

  Read Only: true

  Maximum Length: 80

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : recruitingRACItems-offerList-offerPreviews-item-response

Type: object

Show Source

• Action: string
  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 30

  Action code the job offer activity item relates to.
• AssignmentId: integer (int64)
  Read Only: true

  Assignment ID of the offer being previewed.
• CandidateEmail: string
  Title: Candidate Email

  Read Only: true

  Maximum Length: 240

  Candidate email of the offer being previewed.
• CandidateName: string
  Title: Candidate Name

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 30

  Candidate number of the offer being previewed.
• CandidatePhoneNumber: string
  Title: Candidate Phone Number

  Read Only: true

  Maximum Length: 240

  Candidate phone number of the offer being previewed.
• CurrentPhase: string
  Read Only: true

  Maximum Length: 240

  Current phase of the offer being previewed.
• CurrentState: string
  Title: Offer State

  Read Only: true

  Maximum Length: 240

  Current state of the offer being previewed.
• DaysInThisState: number
  Title: Days in Status

  Read Only: true

  Number of days the selected offer has been in the current state.
• EmployeeStartDate: string (date)
  Read Only: true

  Employee start date of the offer being previewed.
• ExpirationDate: string (date)
  Title: Expiration Date

  Read Only: true

  Expiration date of the offer being previewed.
• ItemId: integer (int64)
  Read Only: true

  Item ID of the offer being previewed.
• LegalEmployer: string
  Read Only: true

  Maximum Length: 240

  Legal employer of the offer being previewed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• offerAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• offerCustomAttachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• OfferId: integer (int64)
  Read Only: true

  Offer ID of the offer being previewed.
• OfferLetterCustomized: string
  Read Only: true

  Maximum Length: 1

  Specifies if the offer letter is modified.
• OfferLetterLayoutName: string
  Maximum Length: 255

  Offer letter layout ID for the offer being previewed.
• RequisitionId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 240

  Requisition number of the offer being previewed.
• RequisitionTitle: string
  Title: Requisition Title

  Read Only: true

  Maximum Length: 240

  Requisition title of the offer being previewed.
• RTFResolved: string
  Read Only: true

  Maximum Length: 1

  Specifies if RTF is resolved for the offer being previewed.
• SubmissionId: integer (int64)
  Read Only: true

  Submission ID for the offer being previewed.
• WorkerType: string
  Read Only: true

  Maximum Length: 80

  Worker type of the offer being previewed.

{
    "type":"object",
    "properties":{
        "offerAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-offerAttachments-item-response"
            }
        },
        "Action":{
            "maxLength":80,
            "type":"string",
            "description":"Action performed on the selected offer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DaysInThisState":{
            "title":"Days in Status",
            "type":"number",
            "description":"Number of days the selected offer has been in the current state.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEmployer":{
            "maxLength":240,
            "type":"string",
            "description":"Legal employer of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Action code the job offer activity item relates to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Item ID of the offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CandidateEmail":{
            "title":"Candidate Email",
            "maxLength":240,
            "type":"string",
            "description":"Candidate email of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "title":"Requisition Number",
            "maxLength":240,
            "type":"string",
            "description":"Requisition number of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RTFResolved":{
            "maxLength":1,
            "type":"string",
            "description":"Specifies if RTF is resolved for the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferId":{
            "type":"integer",
            "description":"Offer ID of the offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID for the offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkerType":{
            "maxLength":80,
            "type":"string",
            "description":"Worker type of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentState":{
            "title":"Offer State",
            "maxLength":240,
            "type":"string",
            "description":"Current state of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Assignment ID of the offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offerCustomAttachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-offerCustomAttachments-item-response"
            }
        },
        "CurrentPhase":{
            "maxLength":240,
            "type":"string",
            "description":"Current phase of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "title":"Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"Candidate number of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferLetterCustomized":{
            "maxLength":1,
            "type":"string",
            "description":"Specifies if the offer letter is modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OfferLetterLayoutName":{
            "maxLength":255,
            "type":"string",
            "description":"Offer letter layout ID for the offer being previewed.",
            "nullable":true,
            "x-queryable":false
        },
        "EmployeeStartDate":{
            "type":"string",
            "description":"Employee start date of the offer being previewed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the offer being previewed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateName":{
            "title":"Candidate Name",
            "maxLength":240,
            "type":"string",
            "description":"Candidate name of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission ID for the offer being previewed.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Requisition Title",
            "maxLength":240,
            "type":"string",
            "description":"Requisition title of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidatePhoneNumber":{
            "title":"Candidate Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Candidate phone number of the offer being previewed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

• Array of: object recruitingRACItems-offerList-offerPreviews-offerAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-offerAttachments-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 recruitingRACItems-offerList-offerPreviews-offerCustomAttachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/recruitingRACItems-offerList-offerPreviews-offerCustomAttachments-item-response"
    }
}

Nested Schema : recruitingRACItems-offerList-offerPreviews-offerAttachments-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 : recruitingRACItems-offerList-offerPreviews-offerCustomAttachments-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"
    }
}

Back to Top