Submit all filters in recruitingCESites
post
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters
Request
Path Parameters
-
SiteNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ColumnName: string
Maximum Length:
255
Column name of the site context filters. -
ContextCode: string
Maximum Length:
255
Context code of the site context filters. -
DFFId: string
Maximum Length:
255
Flexfield ID of the site context filters. -
DimensionKey: string
Key assigned to the dimension in filters.
-
DimensionTypeCode: string
Code assigned to the type of dimensions in the filters.
-
GeographyId: integer
ID assigned to the geography selected in filters.
-
GeographyNodeId: integer
ID assigned to the geographical node selected in the filters.
-
JobFamilyId: integer
ID assigned to the job family in the filters.
-
JobFunctionCode: string
Job function code assigned to the filters.
-
ObjectCtxId: integer
ID assigned to the filters pertaining to the candidate experience.
-
OrganizationId: integer
Organization ID assigned to the filters.
-
RecruitingTypeCode: string
Recruiting type code assigned to the filters.
-
SegmentCode: string
Maximum Length:
255
Segment code of the site context filters.
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 : recruitingCESites-filters-item-response
Type:
Show Source
object
-
ColumnName: string
Maximum Length:
255
Column name of the site context filters. -
ContextCode: string
Maximum Length:
255
Context code of the site context filters. -
DFFId: string
Maximum Length:
255
Flexfield ID of the site context filters. -
DimensionKey: string
Key assigned to the dimension in filters.
-
DimensionTypeCode: string
Code assigned to the type of dimensions in the filters.
-
GeographyId: integer
ID assigned to the geography selected in filters.
-
GeographyNodeId: integer
ID assigned to the geographical node selected in the filters.
-
JobFamilyId: integer
ID assigned to the job family in the filters.
-
JobFunctionCode: string
Job function code assigned to the filters.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectCtxId: integer
ID assigned to the filters pertaining to the candidate experience.
-
OrganizationId: integer
Organization ID assigned to the filters.
-
RecruitingTypeCode: string
Recruiting type code assigned to the filters.
-
SegmentAttributeName: string
Read Only:
true
Maximum Length:255
Segment attribute name of the site context filters. -
SegmentCode: string
Maximum Length:
255
Segment code of the site context filters. -
SegmentName: string
Read Only:
true
Maximum Length:255
Segment name of the site context filters.
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.