Get all details on an opportunity marketplace gig
get
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
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 gig details in opportunity marketplace using a unique ID.
Finder Variables- GigId; integer; Finds gig details in opportunity marketplace using a unique ID and the gig ID.
- findById Finds gig details in opportunity marketplace using findByGidId.
Finder Variables- GigId; integer; Finds gig details in opportunity marketplace using findByGidId and GigIdBindVar.
- findByNumber Finds gig details in opportunity marketplace using findByNumber.
Finder Variables- GigNumber; string; Finds gig details in opportunity marketplace using the number entered by the consumer.
- PrimaryKey Finds gig details in opportunity marketplace using a unique ID.
-
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:- BookmarkFlag; boolean; Indicates whether a gig is bookmarked in opportunity marketplace. The default value is 0
- CanceledApplicationsCount; integer; Number of canceled applications for a gig in opportunity marketplace.
- ClassifyBUId; integer; Business unit identifier for the classification of a gig in opportunity marketplace.
- ClassifyJobFamilyId; integer; Job family identifier for the classification of a gig in opportunity marketplace.
- ClassifyJobFuncCode; string; Job function code for the classification of a gig in opportunity marketplace.
- ClassifyOrgId; integer; Organization identifier for the classification of a gig in opportunity marketplace.
- CompletedApplicationsCount; integer; Number of completed applications for a gig in opportunity marketplace.
- CreatorEmail; string; Email of the gig creator in opportunity marketplace.
- CreatorName; string; Name of the gig creator in opportunity marketplace.
- CreatorPersonId; integer; Person ID of the gig creator in opportunity marketplace.
- CreatorPhoneNumber; string; Phone of the gig creator in opportunity marketplace.
- CreatorPosition; string; Position of the gig creator in opportunity marketplace.
- EndDate; string; End date of a gig in opportunity marketplace.
- FilledCount; integer; Number filled applications for a gig in opportunity marketplace.
- GeographyNodeId; integer; Geographical node ID of the gig location in opportunity marketplace.
- GigId; integer; Gig ID of a gig in opportunity marketplace.
- GigNumber; string; Gig number of a gig in opportunity marketplace.
- GigValidFlag; boolean; Indicates whether a gig is valid in opportunity marketplace. No default value.
- HasAppliedFlag; boolean; Indicates whether someone applied to a gig in opportunity marketplace. The default value is 0.
- Location; string; Location of a gig in opportunity marketplace.
- NewApplicationsCount; integer; Number of new applications for a gig in opportunity marketplace.
- NotSelectedApplicationsCount; integer; Number of applications not selected for a gig in opportunity marketplace.
- OpeningsCount; integer; Number of openings for a gig in opportunity marketplace.
- OrganizationId; integer; Organization ID of a gig in opportunity marketplace.
- PendingApprovalAppsCount; integer; Number of applications pending approval for a gig in opportunity marketplace.
- ProfileId; integer; Profile ID of a gig in opportunity marketplace.
- PublishDate; string; Publish date of a gig in opportunity marketplace.
- RemoteOpportunityFlag; boolean; Indicates whether the gig in opportunity marketplace is a remote opportunity. The default value is 0
- StartDate; string; Start date of a gig in opportunity marketplace.
- StatusCode; string; Status code of a gig in opportunity marketplace.
- TimeCommitment; integer; Time commitment of a gig in opportunity marketplace.
- Title; string; Title of a gig in opportunity marketplace.
- TotalApplicationsCount; integer; Number of all the applications for a gig in opportunity marketplace.
-
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 : recruitingOppMktGigDetails
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 : 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