Get all opportunities in opportunity marketplace
get
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities
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 opportunities in opportunity marketplace using a unique ID.
Finder Variables- SearchId; integer; Finds opportunities in opportunity marketplace using a unique ID and a search ID.
- findOpportunities Finds opportunities in opportunity marketplace.
Finder Variables- categoryCode; string; Finds opportunities in opportunity marketplace using a category code.
- limit; integer; Finds opportunities in opportunity marketplace using a limit; integer; .
- offset; integer; Finds opportunities in opportunity marketplace using an offset; integer; .
- searchTerms; string; Finds opportunities in opportunity marketplace using search terms.
- sortFieldDirection; string; Attribute to sort opportunities in opportunity marketplace using the ascending and descending order.
- sortFieldName; string; Attribute to sort opportunities in opportunity marketplace using the field name.
- PrimaryKey Finds opportunities 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:- HasMoreFlag; boolean; Indicates whether there are more opportunities in the opportunities list.
- Keyword; string; Keyword in opportunity marketplace.
- Limit; integer; Limit in opportunity marketplace.
- Offset; integer; Offset in opportunity marketplace.
- SearchId; integer; Search ID in opportunity marketplace.
- SelectedCategoryCode; string; Selected category code in opportunity marketplace.
- SortingFieldDirection; string; Ascending and descending order to sort opportunities in opportunity marketplace.
- SortingFieldName; string; Field name to sort opportunities 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 : recruitingOppMktOpportunities
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 : recruitingOppMktOpportunities-item-response
Type:
Show Source
object
-
categoriesFacet: array
Categories Facet in Opportunity Marketplace
Title:
Categories Facet in Opportunity Marketplace
The categoriesFacetCategories resource is the child of recruitingOppMktOpportunities resource and provides categories facets in opportunity marketplace. -
HasMoreFlag: boolean
Maximum Length:
1
Indicates whether there are more opportunities in the opportunities list. -
Keyword: string
Keyword in opportunity marketplace.
-
Limit: integer
Limit in opportunity marketplace.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Offset: integer
Offset in opportunity marketplace.
-
opportunityList: array
Opportunities List in Opportunity Marketplace
Title:
Opportunities List in Opportunity Marketplace
The opportunityList resource is the child of recruitingOppMktOpportunities resource and provides a list of opportunities in opportunity marketplace. -
SearchId: integer
Default Value:
1
Search ID in opportunity marketplace. -
SelectedCategoryCode: string
Selected category code in opportunity marketplace.
-
SortingFieldDirection: string
Read Only:
true
Ascending and descending order to sort opportunities in opportunity marketplace. -
SortingFieldName: string
Read Only:
true
Field name to sort opportunities in opportunity marketplace.
Nested Schema : Categories Facet in Opportunity Marketplace
Type:
array
Title:
Categories Facet in Opportunity Marketplace
The categoriesFacetCategories resource is the child of recruitingOppMktOpportunities resource and provides categories facets in opportunity marketplace.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Opportunities List in Opportunity Marketplace
Type:
array
Title:
Opportunities List in Opportunity Marketplace
The opportunityList resource is the child of recruitingOppMktOpportunities resource and provides a list of opportunities in opportunity marketplace.
Show Source
Nested Schema : recruitingOppMktOpportunities-categoriesFacet-item-response
Type:
Show Source
object
-
CategoryCode: string
Category code in category facets in opportunity marketplace.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultsCount: integer
Results count in opportunity marketplace
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 : recruitingOppMktOpportunities-opportunityList-item-response
Type:
Show Source
object
-
Description: string
Read Only:
true
Maximum Length:255
Description of the gig in opportunity marketplace. -
JobOpeningsCount: integer
Read Only:
true
Job openings count for career roles in opportunity marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Location in the opportunity list in opportunity marketplace.
-
OpportunityId: integer
Opportunity ID in the opportunity list in opportunity marketplace.
-
OpportunityNumber: string
Opportunity number in the opportunity list in opportunity marketplace.
-
OpportunityType: string
Opportunity type in the opportunity list in opportunity marketplace.
-
PostedDate: string
Posted date in the opportunity list in opportunity marketplace.
-
RemoteOpportunityFlag: boolean
Read Only:
true
Indicates whether the opportunity is a remote working opportunity in opportunity marketplace. Default value is 0. -
SourceType: string
Read Only:
true
Maximum Length:255
Source type of career roles in opportunity marketplace. -
StartDate: string
Read Only:
true
Start date of a gig in opportunity marketplace. -
Title: string
Title in the opportunity list in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source