Get all details on an opportunity marketplace gig

get

/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails

Request

Query Parameters
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : recruitingOppMktGigDetails
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingOppMktGigDetails-item-response
Type: object
Show Source
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 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-response
Type: object
Show Source
Nested Schema : recruitingOppMktGigDetails-gigApplications-item-response
Type: object
Show Source
Nested Schema : recruitingOppMktGigDetails-gigClassifications-item-response
Type: object
Show Source
Nested Schema : recruitingOppMktGigDetails-gigSkills-item-response
Type: object
Show Source
Nested Schema : recruitingOppMktGigDetails-teamMembers-item-response
Type: object
Show Source
Back to Top