Submit all recruiting job requisitions media links
post
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks
Request
Path Parameters
-
recruitingJobRequisitionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recruiting Job Requisitions resource and used to uniquely identify an instance of Recruiting Job Requisitions. The client should not generate the hash key value. Instead, the client should query on the Recruiting Job Requisitions collection resource in order to navigate to a specific instance of Recruiting Job Requisitions to get the hash key.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
IsShownOnOffers: string
Maximum Length:
1
Is Shown On Offers in recruiting job requisitions media links. -
mediaLanguages: array
Media Languages in Recruiting Job Requisitions
Title:
Media Languages in Recruiting Job Requisitions
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages. -
RequisitionMediaLinkId: integer
(int64)
Requisition Media Link ID in recruiting job requisitions media links.
-
Sequence: integer
(int32)
Sequence in recruiting job requisitions media links.
-
ThumbnailURL: string
Maximum Length:
1000
Thumbnail URL in recruiting job requisitions media links. -
Title: string
Maximum Length:
240
Title in recruiting job requisitions media links. -
Type(required): string
Maximum Length:
30
Type in recruiting job requisitions media links. -
URL: string
Maximum Length:
1000
URL in recruiting job requisitions media links. -
Visibility: string
Maximum Length:
30
Visibility in recruiting job requisitions media links.
Nested Schema : Media Languages in Recruiting Job Requisitions
Type:
array
Title:
Media Languages in Recruiting Job Requisitions
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages.
Show Source
Nested Schema : recruitingJobRequisitions-mediaLinks-mediaLanguages-item-post-request
Type:
Show Source
object
-
MediaLanguageCode: string
Maximum Length:
4
Media Language Code in recruiting job requisitions media languages. -
MediaLanguageId: integer
(int64)
Media Language ID in recruiting job requisitions media languages.
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.
Root Schema : recruitingJobRequisitions-mediaLinks-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Requisition created using the media links. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation Date in recruiting job requisitions media links. -
IsShownOnOffers: string
Maximum Length:
1
Is Shown On Offers in recruiting job requisitions media links. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last Update Date in recruiting job requisitions media links. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Last Update using in recruiting job requisitions media links. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
mediaLanguages: array
Media Languages in Recruiting Job Requisitions
Title:
Media Languages in Recruiting Job Requisitions
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages. -
MediaLinkId: string
Read Only:
true
Maximum Length:18
Media Link ID in recruiting job requisitions media links. -
RequisitionMediaLinkId: integer
(int64)
Requisition Media Link ID in recruiting job requisitions media links.
-
Sequence: integer
(int32)
Sequence in recruiting job requisitions media links.
-
ThumbnailURL: string
Maximum Length:
1000
Thumbnail URL in recruiting job requisitions media links. -
Title: string
Maximum Length:
240
Title in recruiting job requisitions media links. -
Type: string
Maximum Length:
30
Type in recruiting job requisitions media links. -
URL: string
Maximum Length:
1000
URL in recruiting job requisitions media links. -
Visibility: string
Maximum Length:
30
Visibility in recruiting job requisitions media links.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Media Languages in Recruiting Job Requisitions
Type:
array
Title:
Media Languages in Recruiting Job Requisitions
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages.
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 : recruitingJobRequisitions-mediaLinks-mediaLanguages-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Language used in the media for creating the job requisition. -
CreationDate: string
(date-time)
Read Only:
true
Creation Date in recruiting job requisitions media languages. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Update Date in recruiting job requisitions media languages. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Update using in recruiting job requisitions media languages. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MediaLanguageCode: string
Maximum Length:
4
Media Language Code in recruiting job requisitions media languages. -
MediaLanguageId: integer
(int64)
Media Language ID in recruiting job requisitions media languages.
-
MediaLinkId: integer
(int64)
Read Only:
true
Media Link ID in recruiting job requisitions media languages.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- mediaLanguages
-
Parameters:
- mediaLinksUniqID:
$request.path.mediaLinksUniqID
- recruitingJobRequisitionsUniqID:
$request.path.recruitingJobRequisitionsUniqID
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages. - mediaLinksUniqID:
Examples
The following example shows how to create a media link for the job requisition by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X POST -d <payload> http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingJobRequisitions/PR_REQ_501/child/mediaLinks
Example of Payload
The following is an example of the payload.
{ "IsShownOnOffers": "Y", "Sequence": 1, "Visibility": "ORA_BOTH", "Title": "PHOTO 41-A", "Type": "ORA_IMAGE", "URL": "https://c2.staticflickr.com/4/3623/3516003707_38f69a4006_b.jpg", "ThumbnailURL": "https://c2.staticflickr.com/4/3623/3516003707_38f69a4006_b.jpg" }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/octet-stream
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "RequisitionMediaLinkId": 300100175010391, "MediaLinkId": "300100175010392", "Title": "PHOTO 41-A", "Sequence": 1, "Type": "ORA_IMAGE", "Visibility": "ORA_BOTH", "IsShownOnOffers": "Y", "URL": "https://c2.staticflickr.com/4/3623/3516003707_38f69a4006_b.jpg", "ThumbnailURL": "https://c2.staticflickr.com/4/3623/3516003707_38f69a4006_b.jpg", "CreatedBy": "TM-MFITZIMMONS", "CreationDate": "2019-02-25T15:30:22-08:00", "LastUpdatedBy": "TM-MFITZIMMONS", "LastUpdateDate": "2019-02-25T15:30:22.125-08:00", "links": [4] {... ...} }