Submit all regulatory configurations
post
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs
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
-
AFBlockCode: string
Maximum Length:
255
Code assigned to the apply flow block in the secured regulatory configurations. -
AttributeCode: string
Code assigned to the attribute in the secured regulatory configurations
-
AttributeName: string
Attribute name in the regulatory configurations in the secured regulatory configurations.
-
AttributeType: string
Attribute type used to classify the attribute as DDF or standard in the secured regulatory configurations.
-
CheckboxCheckedValue: string
Predefined value assigned to the DDF attribute when the check box is checked in the secured regulatory configurations.
-
CheckboxUncheckedValue: string
Predefined value assigned to the DDF attribute when the check box is unchecked in the secured regulatory configurations.
-
DefaultValue: string
Default value in the secured regulatory configurations
-
DisabledFlag: boolean
Indicator to indicate the configuration setting is disabled in the secured regulatory configurations
-
DisplayPrompt: string
Display prompt in the secured regulatory configurations
-
DisplaySequence: integer
Display sequence in the secured regulatory configurations
-
DisplayTypeCode: string
Code assigned to the display type in the secured regulatory configurations
-
DisplayWidth: string
Display width value predefined for the DDF attribute in the secured regulatory configurations.
- FooterDescription: string
-
HeaderDescription: string
Header description in the secured regulatory configurations
-
HiddenFlag: boolean
Indicator to hide the configurations in the secured regulatory configurations
-
LegislationCode: string
Legislation code in the secured regulatory configurations
-
LegislationName: string
Legislation name in the secured regulatory configurations
-
LookupType: string
Lookup type in the secured regulatory configurations
-
MaximumLength: string
Maximum length predefined for the DDF attribute in the secured regulatory configurations.
-
MaximumValue: string
Maximum value predefined for the DDF attribute in the secured regulatory configurations.
-
MinimumValue: string
Minimum value predefined for the DDF attribute in the secured regulatory configurations.
-
Options: string
Options in the secured regulatory configurations
-
Precision: integer
Precision value predefined for the DDF attribute in the secured regulatory configurations.
-
RequiredFlag: boolean
Required indicator in the secured regulatory configurations
-
RequisitionNumber: string
Requisition number in the secured regulatory configurations
-
ResponseTypeCode: string
Code assigned to the response type in the secured regulatory configurations
-
Scale: string
Scale value predefined for the DDF attribute in the secured regulatory configurations.
-
SegmentColumnName: string
Segment column name predefined for the DDF attribute in the secured regulatory configurations.
-
SegmentName: string
Segment name predefined for the DDF attribute in the secured regulatory configurations.
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 : recruitingJobSiteRegulatoryConfigs-item-response
Type:
Show Source
object
-
AFBlockCode: string
Maximum Length:
255
Code assigned to the apply flow block in the secured regulatory configurations. -
AttributeCode: string
Code assigned to the attribute in the secured regulatory configurations
-
AttributeName: string
Attribute name in the regulatory configurations in the secured regulatory configurations.
-
AttributeType: string
Attribute type used to classify the attribute as DDF or standard in the secured regulatory configurations.
-
CheckboxCheckedValue: string
Predefined value assigned to the DDF attribute when the check box is checked in the secured regulatory configurations.
-
CheckboxUncheckedValue: string
Predefined value assigned to the DDF attribute when the check box is unchecked in the secured regulatory configurations.
-
DefaultValue: string
Default value in the secured regulatory configurations
-
DisabledFlag: boolean
Indicator to indicate the configuration setting is disabled in the secured regulatory configurations
-
DisplayPrompt: string
Display prompt in the secured regulatory configurations
-
DisplaySequence: integer
Display sequence in the secured regulatory configurations
-
DisplayTypeCode: string
Code assigned to the display type in the secured regulatory configurations
-
DisplayWidth: string
Display width value predefined for the DDF attribute in the secured regulatory configurations.
- FooterDescription: string
-
HeaderDescription: string
Header description in the secured regulatory configurations
-
HiddenFlag: boolean
Indicator to hide the configurations in the secured regulatory configurations
-
LegislationCode: string
Legislation code in the secured regulatory configurations
-
LegislationName: string
Legislation name in the secured regulatory configurations
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupType: string
Lookup type in the secured regulatory configurations
-
MaximumLength: string
Maximum length predefined for the DDF attribute in the secured regulatory configurations.
-
MaximumValue: string
Maximum value predefined for the DDF attribute in the secured regulatory configurations.
-
MinimumValue: string
Minimum value predefined for the DDF attribute in the secured regulatory configurations.
-
Options: string
Options in the secured regulatory configurations
-
Precision: integer
Precision value predefined for the DDF attribute in the secured regulatory configurations.
-
RequiredFlag: boolean
Required indicator in the secured regulatory configurations
-
RequisitionNumber: string
Requisition number in the secured regulatory configurations
-
ResponseTypeCode: string
Code assigned to the response type in the secured regulatory configurations
-
Scale: string
Scale value predefined for the DDF attribute in the secured regulatory configurations.
-
SegmentColumnName: string
Segment column name predefined for the DDF attribute in the secured regulatory configurations.
-
SegmentName: string
Segment name predefined for the DDF attribute in the secured regulatory configurations.
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.