Create gig details in opportunity marketplace
post
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
Request
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
-
benefits: array
Gig Benefits
Title:
Gig Benefits
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace. -
ClassifyBUId: integer
(int64)
Business unit identifier for the classification of a gig in opportunity marketplace.
-
ClassifyJobFamilyId: integer
(int64)
Job family identifier for the classification of a gig in opportunity marketplace.
-
ClassifyJobFuncCode: string
Maximum Length:
30
Job function code for the classification of a gig in opportunity marketplace. -
ClassifyOrgId: integer
(int64)
Organization identifier for the classification of a gig in opportunity marketplace.
-
Description(required): string
(byte)
Description of the gig in opportunity marketplace.
-
EndDate: string
(date-time)
End date of a gig in opportunity marketplace.
-
GeographyNodeId: integer
(int64)
Geographical node ID of the gig location in opportunity marketplace.
-
gigApplications: array
Gig Applications
Title:
Gig Applications
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace. -
gigClassifications: array
Gig Classifications
Title:
Gig Classifications
The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace. -
GigId: integer
(int64)
Gig ID of a gig in opportunity marketplace.
-
gigMediaLinks: array
Gig Media Links
Title:
Gig Media Links
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace. -
gigSkills: array
Gig Skills
Title:
Gig Skills
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace. -
OpeningsCount: integer
(int32)
Number of openings for a gig in opportunity marketplace.
-
ProfileId: integer
(int64)
Profile ID of a gig in opportunity marketplace.
-
PublishDate: string
(date-time)
Publish date of a gig in opportunity marketplace.
-
RemoteOpportunityFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the gig in opportunity marketplace is a remote opportunity. The default value is 0 -
StartDate(required): string
(date-time)
Start date of a gig in opportunity marketplace.
-
StatusCode: string
Maximum Length:
30
Default Value:Draft
Status code of a gig in opportunity marketplace. -
teamMembers: array
Gig Team Members
Title:
Gig Team Members
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace. -
TimeCommitment: integer
(int32)
Time commitment of a gig in opportunity marketplace.
-
Title(required): string
Maximum Length:
240
Title of a gig in opportunity marketplace.
Nested Schema : Gig Benefits
Type:
array
Title:
Gig Benefits
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Applications
Type:
array
Title:
Gig Applications
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Classifications
Type:
array
Title:
Gig Classifications
The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Media Links
Type:
array
Title:
Gig Media Links
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Skills
Type:
array
Title:
Gig Skills
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Team Members
Type:
array
Title:
Gig Team Members
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace.
Show Source
Nested Schema : recruitingOppMktGigDetails-benefits-item-post-request
Type:
Show Source
object
-
BenefitId: integer
(int64)
Benefit ID of a gig benefit in opportunity marketplace.
-
Description: string
(byte)
Description of a gig benefit in opportunity marketplace.
Nested Schema : recruitingOppMktGigDetails-gigApplications-item-post-request
Type:
Show Source
object
Nested Schema : recruitingOppMktGigDetails-gigClassifications-item-post-request
Type:
Show Source
object
-
ClassificationId: integer
(int64)
Classification identifier for the specific classification of a gig in opportunity marketplace.
-
GigId: integer
(int64)
Gig identifier for a classification in opportunity marketplace.
-
JobId: integer
(int64)
Job identifier for a classification in opportunity marketplace.
Nested Schema : recruitingOppMktGigDetails-gigMediaLinks-item-post-request
Type:
Show Source
object
-
GigMediaLinkId: integer
(int64)
Unique ID for the gig media link in opportunity marketplace.
-
LookupCode: string
Code for the gig media link in opportunity marketplace.
-
ThumbnailURL: string
Maximum Length:
1000
URL for the media thumbnail in opportunity marketplace. -
Title: string
Maximum Length:
240
Title of gig media link in opportunity marketplace. -
URL: string
Maximum Length:
1000
URL of the gig media link in opportunity marketplace.
Nested Schema : recruitingOppMktGigDetails-gigSkills-item-post-request
Type:
Show Source
object
-
SkillId: integer
(int64)
Skill ID for a gig in opportunity marketplace.
-
Skills: string
Title:
Skill
Maximum Length:240
Skill content for a gig in opportunity marketplace.
Nested Schema : schema
Type:
Show Source
object
-
OpportunityType: string
Maximum Length:
30
Opportunity type for a gig team member in opportunity marketplace. -
TeamMemberId: integer
(int64)
Team member ID in opportunity marketplace.
-
TeamMemberPersonId: integer
(int64)
Person ID of a gig team member in opportunity marketplace.
-
TeamMemberRole: string
Maximum Length:
240
Role of a gig team member in opportunity marketplace.
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 : recruitingOppMktGigDetails-item-response
Type:
Show Source
object
-
benefits: array
Gig Benefits
Title:
Gig Benefits
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace. -
BookmarkFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a gig is bookmarked in opportunity marketplace. The default value is 0 -
CanceledApplicationsCount: integer
Read Only:
true
Number of canceled applications for a gig in opportunity marketplace. -
ClassifyBUId: integer
(int64)
Business unit identifier for the classification of a gig in opportunity marketplace.
-
ClassifyJobFamilyId: integer
(int64)
Job family identifier for the classification of a gig in opportunity marketplace.
-
ClassifyJobFuncCode: string
Maximum Length:
30
Job function code for the classification of a gig in opportunity marketplace. -
ClassifyOrgId: integer
(int64)
Organization identifier for the classification of a gig in opportunity marketplace.
-
CompletedApplicationsCount: integer
Read Only:
true
Number of completed applications for a gig in opportunity marketplace. -
CreatorEmail: string
Read Only:
true
Maximum Length:255
Email of the gig creator in opportunity marketplace. -
CreatorName: string
Read Only:
true
Maximum Length:255
Name of the gig creator in opportunity marketplace. -
CreatorPersonId: integer
(int64)
Read Only:
true
Person ID of the gig creator in opportunity marketplace. -
CreatorPhoneNumber: string
Read Only:
true
Maximum Length:255
Phone of the gig creator in opportunity marketplace. -
CreatorPosition: string
Read Only:
true
Maximum Length:255
Position of the gig creator in opportunity marketplace. -
Description: string
(byte)
Description of the gig in opportunity marketplace.
-
DescriptionStr: string
Read Only:
true
Maximum Length:255
Description details of a gig in opportunity marketplace. -
EndDate: string
(date-time)
End date of a gig in opportunity marketplace.
-
FilledCount: integer
(int32)
Read Only:
true
Default Value:0
Number filled applications for a gig in opportunity marketplace. -
GeographyNodeId: integer
(int64)
Geographical node ID of the gig location in opportunity marketplace.
-
gigApplications: array
Gig Applications
Title:
Gig Applications
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace. -
gigClassifications: array
Gig Classifications
Title:
Gig Classifications
The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace. -
GigId: integer
(int64)
Gig ID of a gig in opportunity marketplace.
-
gigMediaLinks: array
Gig Media Links
Title:
Gig Media Links
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace. -
GigNumber: string
Read Only:
true
Maximum Length:240
Gig number of a gig in opportunity marketplace. -
gigSkills: array
Gig Skills
Title:
Gig Skills
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace. -
GigValidFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether a gig is valid in opportunity marketplace. No default value. -
HasAppliedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether someone applied to a gig in opportunity marketplace. The default value is 0. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:255
Location of a gig in opportunity marketplace. -
NewApplicationsCount: integer
Read Only:
true
Number of new applications for a gig in opportunity marketplace. -
NotSelectedApplicationsCount: integer
Read Only:
true
Number of applications not selected for a gig in opportunity marketplace. -
OpeningsCount: integer
(int32)
Number of openings for a gig in opportunity marketplace.
-
OrganizationId: integer
(int64)
Read Only:
true
Organization ID of a gig in opportunity marketplace. -
PendingApprovalAppsCount: integer
Read Only:
true
Number of applications pending approval for a gig in opportunity marketplace. -
ProfileId: integer
(int64)
Profile ID of a gig in opportunity marketplace.
-
PublishDate: string
(date-time)
Publish date of a gig in opportunity marketplace.
-
RemoteOpportunityFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the gig in opportunity marketplace is a remote opportunity. The default value is 0 -
StartDate: string
(date-time)
Start date of a gig in opportunity marketplace.
-
StatusCode: string
Maximum Length:
30
Default Value:Draft
Status code of a gig in opportunity marketplace. -
teamMembers: array
Gig Team Members
Title:
Gig Team Members
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace. -
TimeCommitment: integer
(int32)
Time commitment of a gig in opportunity marketplace.
-
Title: string
Maximum Length:
240
Title of a gig in opportunity marketplace. -
TotalApplicationsCount: integer
Read Only:
true
Number of all the applications for a gig in opportunity marketplace.
Nested Schema : Gig Benefits
Type:
array
Title:
Gig Benefits
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Applications
Type:
array
Title:
Gig Applications
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Classifications
Type:
array
Title:
Gig Classifications
The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Media Links
Type:
array
Title:
Gig Media Links
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace.
Show Source
Nested Schema : Gig Skills
Type:
array
Title:
Gig Skills
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Gig Team Members
Type:
array
Title:
Gig Team Members
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace.
Show Source
Nested Schema : recruitingOppMktGigDetails-benefits-item-response
Type:
Show Source
object
-
BenefitId: integer
(int64)
Benefit ID of a gig benefit in opportunity marketplace.
-
Description: string
(byte)
Description of a gig benefit in opportunity marketplace.
-
DescriptionStr: string
Read Only:
true
Description details of a gig benefit in opportunity marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : recruitingOppMktGigDetails-gigApplications-item-response
Type:
Show Source
object
-
ApplicationDate: string
(date-time)
Read Only:
true
Application date of opportunities in Opportunity Marketplace. -
ApplicationId: integer
(int64)
Read Only:
true
Application ID of a gig application in opportunity marketplace. -
AssignmentName: string
Read Only:
true
Maximum Length:255
Name of the assignment in a gig application in Opportunity Marketplace. -
CompletedGigCount: integer
Read Only:
true
Number of gigs completed by a candidate in opportunity marketplace. -
IsRecommendedFlag: boolean
Read Only:
true
Maximum Length:1
Flag denoting whether this candidate was a recommended candidate in opportunity marketplace. -
JobName: string
Read Only:
true
Maximum Length:255
Job name in a gig application in opportunity marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationName: string
Read Only:
true
Location name of the candidate in opportunity marketplace. -
Name: string
Read Only:
true
Name in a gig application in opportunity marketplace. -
OrganizationName: string
Read Only:
true
Organization name of the candidate in opportunity marketplace. -
PersonId: integer
(int64)
Read Only:
true
Person ID in a gig application in opportunity marketplace. -
StatusCode: string
Read Only:
true
Maximum Length:30
Status code of an application for a gig in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingOppMktGigDetails-gigClassifications-item-response
Type:
Show Source
object
-
ClassificationId: integer
(int64)
Classification identifier for the specific classification of a gig in opportunity marketplace.
-
GigId: integer
(int64)
Gig identifier for a classification in opportunity marketplace.
-
JobId: integer
(int64)
Job identifier for a classification in opportunity marketplace.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingOppMktGigDetails-gigMediaLinks-item-response
Type:
Show Source
object
-
GigMediaLinkId: integer
(int64)
Unique ID for the gig media link in opportunity marketplace.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Code for the gig media link in opportunity marketplace.
-
ThumbnailURL: string
Maximum Length:
1000
URL for the media thumbnail in opportunity marketplace. -
Title: string
Maximum Length:
240
Title of gig media link in opportunity marketplace. -
URL: string
Maximum Length:
1000
URL of the gig media link in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingOppMktGigDetails-gigSkills-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SkillId: integer
(int64)
Skill ID for a gig in opportunity marketplace.
-
Skills: string
Title:
Skill
Maximum Length:240
Skill content for a gig in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingOppMktGigDetails-teamMembers-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpportunityType: string
Maximum Length:
30
Opportunity type for a gig team member in opportunity marketplace. -
TeamMemberEmailAddress: string
Read Only:
true
Maximum Length:255
Email address of a gig team member in opportunity marketplace. -
TeamMemberId: integer
(int64)
Team member ID in opportunity marketplace.
-
TeamMemberName: string
Read Only:
true
Maximum Length:255
Name of a gig team member in opportunity marketplace. -
TeamMemberPersonId: integer
(int64)
Person ID of a gig team member in opportunity marketplace.
-
TeamMemberPhoneNumber: string
Read Only:
true
Maximum Length:255
Phone of a gig team member in opportunity marketplace. -
TeamMemberRole: string
Maximum Length:
240
Role of a gig team member in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- GeoHierarchyNodesVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: GeographyNodeId; Target Attribute: GeographyNodeId
- Display Attribute: GeographyNodeId
- benefits
-
Parameters:
- GigId:
$request.path.GigId
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace. - GigId:
- gigApplications
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigApplicationsParameters:
- GigId:
$request.path.GigId
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace. - GigId:
- gigClassifications
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassificationsParameters:
- GigId:
$request.path.GigId
The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace. - GigId:
- gigMediaLinks
-
Parameters:
- GigId:
$request.path.GigId
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace. - GigId:
- gigSkills
-
Parameters:
- GigId:
$request.path.GigId
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace. - GigId:
- teamMembers
-
Parameters:
- GigId:
$request.path.GigId
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace. - GigId: