Get data about all job offers
get
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds all created and updated job offers using a unique identifier.
Finder Variables- OfferId; integer; Unique identifier and offer identifier used to find created and updated job offers.
- findByOfferId Finds all created and updated job offers using a job offer identifier.
Finder Variables- OfferId; integer; Job offer identifier used to find created and updated job offers.
- findBySubmissionId Finds all created and updated job offers using a submission identifier.
Finder Variables- SubmissionId; integer; Submission identifier used to find created and updated job offers.
- PrimaryKey Finds all created and updated job offers using a unique identifier.
-
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:- AcceptedDate; string; Date when the job offer was accepted.
- AcceptedOnBehalfById; integer; Identifier of the person who accepted the job offer on behalf of the candidate.
- AcceptedOnBehalfDate; string; Date when the person accepted the job offer on behalf of the candidate.
- Additionaltextone; string; First additional information text field.
- Additionaltexttwo; string; Second additional information text field.
- AsgActionCode; string; Assignment action code for the job offer being created or updated.
- AssignmentContractId; integer; Assignment contract identifier in the job offer being created or updated.
- AssignmentId; integer; Assignment identifier of the job offer being created or updated.
- AssignmentOfferId; integer; Offer assignment identifier of the job offer being created or updated.
- AssignmentPositionId; integer; Assignment position identifier of the job offer being created or updated.
- BusinessGroupId; integer; Business group identifier of the job offer being created or updated.
- BusinessUnitId; integer; Business unit identifier of the job offer being created or updated.
- CanUpdateCandidateJobOfferLetter; string; Flag to check if user has download to update offer letter of the job offer being created or updated.
- CandidateNumber; string; Candidate number of the candidate for which the job offer is being created or updated.
- CandidateType; string; Candidate type of the candidate for which the job offer is being created or updated.
- CategoryCandidate; string; Category of the candidate for which the job offer is being created or updated.
- Code; string; Code of the job offer being created or updated.
- Comments; string; Comments of the job offer being created or updated.
- CountryCode; string; Country code of the job offer being created or updated.
- CurrentPhaseId; integer; Current phase identifier of the job offer being created or updated.
- CurrentStateId; integer; Current state identifier of the job offer being created or updated.
- DepartmentId; integer; Department identifier of the job offer being created or updated.
- Description; string; Description of the job offer being created or updated.
- EffectiveEndDate; string; Effective end date of the job offer being created or updated.
- EffectiveStartDate; string; Effective start date of the job offer being created or updated.
- EsignatureInstructions; string; E signature instructions in the job offer being created or updated.
- ExpirationDate; string; Expiration date of the job offer being created or updated.
- FullPartTime; string; Full time or part time attribute of the job offer being created or updated.
- GradeId; integer; Grade identifier of the job offer being created or updated.
- HandoffHRScenarioId; integer; Handoff HR scenario identifier for the job offer being created or updated.
- HiringManagerAssignmentId; integer; Hiring manager assignment identifier of the job offer being created or updated.
- HiringManagerId; integer; Hiring manager identifier of the job offer being created or updated.
- HiringManagerPersonNumber; string; Hiring manager number of the job offer being created or updated.
- JobId; integer; Job identifier of the job offer being created or updated.
- LegalEmployerId; integer; Legal employer identifier of the job offer being created or updated.
- LegalEntityId; integer; Legal entity identifier of the job offer being created or updated.
- LocationId; integer; Location identifier of the job offer being created or updated.
- Name; string; Name of the job offer being created or updated.
- ObjectStatus; string; Object status of the job offer being created or updated.
- OfferComments; string; Offer comments of the job offer being created or updated.
- OfferId; integer; Offer identifier of the job offer being created or updated.
- OfferLetterCustomized; string; Modified offer letter in the job offer being created or updated.
- OfferLetterLayoutId; integer; Offer letter layout identifier in the job offer being created or updated.
- OfferLetterLayoutName; string; Offer letter layout name in the job offer being created or updated.
- OfferName; string; Offer object status of the job offer being created or updated.
- OfferObjectStatus; string; Offer name of the job offer being created or updated.
- ParentOfferId; integer; Parent offer identifier of the job offer being created or updated.
- PersonId; integer; Person identifier of the job offer being created or updated.
- PhaseId; integer; Phase identifier of the job offer being created or updated.
- PositionId; integer; Position identifier of the job offer being created or updated.
- PreselectedHRActionId; integer; Preselected HR action identifier for the job offer being created or updated.
- PreselectedHRActiontypeCode; string; Preselected HR action type code for the job offer being created or updated.
- ProjectedStartDate; string; Projected start date of the job offer being created or updated.
- RecruiterAssignmentId; integer; Recruiter assignment identifier of the job offer being created or updated.
- RecruiterId; integer; Recruiter identifier of the job offer being created or updated.
- RecruitingTypeCode; string; Recruiting type of the job offer being created or updated.
- RedraftCount; integer; Redraft count of the job offer being created or updated.
- RegularTemporary; string; Regular or temporary attribute of the job offer being created or updated.
- RequisitionCurrentPhaseId; integer; Requisition current phase identifier of the job offer being created or updated.
- RequisitionCurrentStateId; integer; Requisition current state identifier of the job offer being created or updated.
- RequisitionHiringManagerAsmtId; integer; Requisition hiring manager assignment identifier for the job offer being created or updated.
- RequisitionHiringManagerId; integer; Requisition hiring manager identifier for the job offer being created or updated.
- RequisitionId; integer; Requisition identifier of the job offer being created or updated.
- RequisitionNumber; string; Requisition number of the job offer being created or updated.
- SiteNumber; string; Site number of the job offer being created or updated.
- StateId; integer; State identifier of the job offer being created or updated.
- StatePostProcessStatus; string; State post process status of the job offer being created or updated.
- SubmissionId; integer; Submission identifier of the job offer being created or updated.
- SubmissionLanguage; string; Submission language of the job offer being created or updated.
- SubmissionLanguageCode; string; Submission language code of the job offer being created or updated.
- WithdrawnRejectedDate; string; Date when candidate is withdrawn or rejected in the job offer being created or updated.
- WorkTermsAssignmentId; integer; Work term assignment identifier for the job offer being created or updated.
- WorkerTypeCode; string; Worker type code of the job offer being created or updated.
- offerIdToUpdate; integer; Offer identifier to update of the job offer being created or updated.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : recruitingUICreateOrUpdateJobOffers
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-item-response
Type:
Show Source
object
-
AcceptedDate: string
(date-time)
Date when the job offer was accepted.
-
AcceptedOnBehalfById: integer
Identifier of the person who accepted the job offer on behalf of the candidate.
-
AcceptedOnBehalfDate: string
(date-time)
Date when the person accepted the job offer on behalf of the candidate.
-
additionalInformationDetails: array
additionalInformationDetails
-
Additionaltextone: string
Maximum Length:
4000
First additional information text field. -
Additionaltexttwo: string
Maximum Length:
4000
Second additional information text field. -
AsgActionCode: string
Read Only:
true
Maximum Length:255
Assignment action code for the job offer being created or updated. -
AssignmentContractId: integer
Assignment contract identifier in the job offer being created or updated.
-
AssignmentId: integer
Assignment identifier of the job offer being created or updated.
-
AssignmentOfferId: integer
Offer assignment identifier of the job offer being created or updated.
-
AssignmentPositionId: integer
Assignment position identifier of the job offer being created or updated.
-
BusinessGroupId: integer
Business group identifier of the job offer being created or updated.
-
BusinessUnitId: integer
Business unit identifier of the job offer being created or updated.
-
CandidateNumber: string
Maximum Length:
255
Candidate number of the candidate for which the job offer is being created or updated. -
candidateOfferLetter: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CandidateType: string
Maximum Length:
255
Candidate type of the candidate for which the job offer is being created or updated. -
CanUpdateCandidateJobOfferLetter: string
Read Only:
true
Maximum Length:255
Flag to check if user has download to update offer letter of the job offer being created or updated. -
CategoryCandidate: string
Maximum Length:
255
Category of the candidate for which the job offer is being created or updated. -
Code: string
Maximum Length:
255
Code of the job offer being created or updated. -
collaborators: array
Recruiting Job Offer Collaborators
Title:
Recruiting Job Offer Collaborators
The collaborators resource provides details about the collaborators of a job offer. -
Comments: string
Maximum Length:
255
Comments of the job offer being created or updated. -
CountryCode: string
Maximum Length:
255
Country code of the job offer being created or updated. -
CurrentPhaseId: integer
Current phase identifier of the job offer being created or updated.
-
CurrentStateId: integer
Current state identifier of the job offer being created or updated.
-
DepartmentId: integer
Department identifier of the job offer being created or updated.
-
Description: string
Maximum Length:
255
Description of the job offer being created or updated. -
EffectiveEndDate: string
(date)
Effective end date of the job offer being created or updated.
-
EffectiveStartDate: string
(date)
Effective start date of the job offer being created or updated.
-
EsignatureInstructions: string
(byte)
E signature instructions in the job offer being created or updated.
-
ExpirationDate: string
(date-time)
Expiration date of the job offer being created or updated.
-
FullPartTime: string
Maximum Length:
255
Full time or part time attribute of the job offer being created or updated. -
GradeId: integer
Grade identifier of the job offer being created or updated.
-
HandoffHRScenarioId: integer
Handoff HR scenario identifier for the job offer being created or updated.
-
HiringManagerAssignmentId: integer
Hiring manager assignment identifier of the job offer being created or updated.
-
HiringManagerId: integer
Hiring manager identifier of the job offer being created or updated.
-
HiringManagerPersonNumber: string
Maximum Length:
255
Hiring manager number of the job offer being created or updated. -
internalAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
JobId: integer
Job identifier of the job offer being created or updated.
-
LegalEmployerId: integer
Legal employer identifier of the job offer being created or updated.
-
LegalEntityId: integer
Legal entity identifier of the job offer being created or updated.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
Location identifier of the job offer being created or updated.
-
Name: string
Maximum Length:
255
Name of the job offer being created or updated. -
ObjectStatus: string
Maximum Length:
255
Object status of the job offer being created or updated. -
offerAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
OfferComments: string
Maximum Length:
4000
Offer comments of the job offer being created or updated. -
OfferId: integer
Offer identifier of the job offer being created or updated.
-
offerIdToUpdate: integer
Offer identifier to update of the job offer being created or updated.
-
OfferLetterCustomized: string
Maximum Length:
255
Modified offer letter in the job offer being created or updated. -
OfferLetterLayoutId: integer
Offer letter layout identifier in the job offer being created or updated.
-
OfferLetterLayoutName: string
Maximum Length:
255
Offer letter layout name in the job offer being created or updated. -
OfferName: string
Maximum Length:
255
Offer object status of the job offer being created or updated. -
OfferObjectStatus: string
Maximum Length:
255
Offer name of the job offer being created or updated. -
ParentOfferId: integer
Parent offer identifier of the job offer being created or updated.
-
PersonId: integer
Person identifier of the job offer being created or updated.
-
PhaseId: integer
Phase identifier of the job offer being created or updated.
-
PositionId: integer
Position identifier of the job offer being created or updated.
-
PreselectedHRActionId: integer
Preselected HR action identifier for the job offer being created or updated.
-
PreselectedHRActiontypeCode: string
Maximum Length:
255
Preselected HR action type code for the job offer being created or updated. -
ProjectedStartDate: string
(date)
Projected start date of the job offer being created or updated.
-
RecruiterAssignmentId: integer
Recruiter assignment identifier of the job offer being created or updated.
-
RecruiterId: integer
Recruiter identifier of the job offer being created or updated.
-
RecruitingTypeCode: string
Maximum Length:
255
Recruiting type of the job offer being created or updated. -
RedraftCount: integer
Redraft count of the job offer being created or updated.
-
RegularTemporary: string
Maximum Length:
255
Regular or temporary attribute of the job offer being created or updated. -
RequisitionCurrentPhaseId: integer
Requisition current phase identifier of the job offer being created or updated.
-
RequisitionCurrentStateId: integer
Requisition current state identifier of the job offer being created or updated.
-
RequisitionHiringManagerAsmtId: integer
Read Only:
true
Requisition hiring manager assignment identifier for the job offer being created or updated. -
RequisitionHiringManagerId: integer
Read Only:
true
Requisition hiring manager identifier for the job offer being created or updated. -
RequisitionId: integer
Requisition identifier of the job offer being created or updated.
-
RequisitionNumber: string
Maximum Length:
255
Requisition number of the job offer being created or updated. -
SiteNumber: string
Maximum Length:
255
Site number of the job offer being created or updated. -
StateId: integer
State identifier of the job offer being created or updated.
-
StatePostProcessStatus: string
Maximum Length:
255
State post process status of the job offer being created or updated. -
SubmissionId: integer
Submission identifier of the job offer being created or updated.
-
SubmissionLanguage: string
Read Only:
true
Maximum Length:255
Submission language of the job offer being created or updated. -
SubmissionLanguageCode: string
Maximum Length:
255
Submission language code of the job offer being created or updated. -
WithdrawnRejectedDate: string
(date-time)
Date when candidate is withdrawn or rejected in the job offer being created or updated.
-
WorkerTypeCode: string
Maximum Length:
255
Worker type code of the job offer being created or updated. -
WorkTermsAssignmentId: integer
Work term assignment identifier for the job offer being created or updated.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recruiting Job Offer Collaborators
Type:
array
Title:
Recruiting Job Offer Collaborators
The collaborators resource provides details about the collaborators of a job offer.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-additionalInformationDetails-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : recruitingUICreateOrUpdateJobOffers-candidateOfferLetter-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-collaborators-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Assignment identifier for the collaborators.
-
AssignmentName: string
Read Only:
true
Maximum Length:255
Assignment name for the collaborators. -
CollaboratorName: string
Read Only:
true
Maximum Length:255
Collaborator name for the collaborators. -
CollaboratorRespTypeCode: string
Maximum Length:
30
Responsibility type code for the collaborators. -
CollaboratorTypeName: string
Read Only:
true
Maximum Length:255
Collaborator type name for the collaborators. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberTypeCode: string
Maximum Length:
30
Member type code for the collaborators. -
ObjectId: integer
(int64)
Object identifier for the collaborators.
-
ObjectType: string
Maximum Length:
30
Object type for the collaborators. -
ObjectVersionNumber: integer
(int32)
Object version number for the collaborators.
-
PersonId: integer
(int64)
Person identifier for the collaborators.
-
TeamMemberId: integer
(int64)
Team member identifier for the collaborators.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-internalAttachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-offerAttachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- downloadFileActionListener
-
Downloads a job offer letter.
- populateEditOfferHCMParams
-
Populates parameters when editing a job offer.