Jump to

• Request
• Response

Update a regulatory configuration

patch

/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}

Request

Path Parameters

• RequisitionNumber(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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
  Footer description in the secured regulatory configurations
• 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.

{
    "type":"object",
    "properties":{
        "FooterDescription":{
            "type":"string",
            "description":"Footer description in the secured regulatory configurations",
            "nullable":true
        },
        "Options":{
            "type":"string",
            "description":"Options in the secured regulatory configurations",
            "nullable":true
        },
        "ResponseTypeCode":{
            "type":"string",
            "description":"Code assigned to the response type in the secured regulatory configurations",
            "nullable":true
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation code in the secured regulatory configurations",
            "nullable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence in the secured regulatory configurations",
            "nullable":true
        },
        "MaximumValue":{
            "type":"string",
            "description":"Maximum value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "HeaderDescription":{
            "type":"string",
            "description":"Header description in the secured regulatory configurations",
            "nullable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the secured regulatory configurations",
            "nullable":true
        },
        "DisabledFlag":{
            "type":"boolean",
            "description":"Indicator to indicate the configuration setting is disabled in the secured regulatory configurations",
            "nullable":true
        },
        "DefaultValue":{
            "type":"string",
            "description":"Default value in the secured regulatory configurations",
            "nullable":true
        },
        "MaximumLength":{
            "type":"string",
            "description":"Maximum length predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "AttributeType":{
            "type":"string",
            "description":"Attribute type used to classify the attribute as DDF or standard in the secured regulatory configurations.",
            "nullable":true
        },
        "DisplayWidth":{
            "type":"string",
            "description":"Display width value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "AttributeName":{
            "type":"string",
            "description":"Attribute name in the regulatory configurations in the secured regulatory configurations.",
            "nullable":true
        },
        "CheckboxUncheckedValue":{
            "type":"string",
            "description":"Predefined value assigned to the DDF attribute when the check box is unchecked in the secured regulatory configurations.",
            "nullable":true
        },
        "AFBlockCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code assigned to the apply flow block in the secured regulatory configurations.",
            "nullable":true
        },
        "LookupType":{
            "type":"string",
            "description":"Lookup type in the secured regulatory configurations",
            "nullable":true
        },
        "SegmentName":{
            "type":"string",
            "description":"Segment name predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "Scale":{
            "type":"string",
            "description":"Scale value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "DisplayPrompt":{
            "type":"string",
            "description":"Display prompt in the secured regulatory configurations",
            "nullable":true
        },
        "AttributeCode":{
            "type":"string",
            "description":"Code assigned to the attribute in the secured regulatory configurations",
            "nullable":true
        },
        "HiddenFlag":{
            "type":"boolean",
            "description":"Indicator to hide the configurations in the secured regulatory configurations",
            "nullable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Precision value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "DisplayTypeCode":{
            "type":"string",
            "description":"Code assigned to the display type in the secured regulatory configurations",
            "nullable":true
        },
        "SegmentColumnName":{
            "type":"string",
            "description":"Segment column name predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Required indicator in the secured regulatory configurations",
            "nullable":true
        },
        "CheckboxCheckedValue":{
            "type":"string",
            "description":"Predefined value assigned to the DDF attribute when the check box is checked in the secured regulatory configurations.",
            "nullable":true
        },
        "MinimumValue":{
            "type":"string",
            "description":"Minimum value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true
        },
        "LegislationName":{
            "type":"string",
            "description":"Legislation name in the secured regulatory configurations",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : recruitingCERegulatoryConfigs-item-response

Type: object

Show Source

• 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
  Footer description in the secured regulatory configurations
• 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.

{
    "type":"object",
    "properties":{
        "FooterDescription":{
            "type":"string",
            "description":"Footer description in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "Options":{
            "type":"string",
            "description":"Options in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseTypeCode":{
            "type":"string",
            "description":"Code assigned to the response type in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation code in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumValue":{
            "type":"string",
            "description":"Maximum value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderDescription":{
            "type":"string",
            "description":"Header description in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionNumber":{
            "type":"string",
            "description":"Requisition number in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "DisabledFlag":{
            "type":"boolean",
            "description":"Indicator to indicate the configuration setting is disabled in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "type":"string",
            "description":"Default value in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumLength":{
            "type":"string",
            "description":"Maximum length predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeType":{
            "type":"string",
            "description":"Attribute type used to classify the attribute as DDF or standard in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayWidth":{
            "type":"string",
            "description":"Display width value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "type":"string",
            "description":"Attribute name in the regulatory configurations in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckboxUncheckedValue":{
            "type":"string",
            "description":"Predefined value assigned to the DDF attribute when the check box is unchecked in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "AFBlockCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code assigned to the apply flow block in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "LookupType":{
            "type":"string",
            "description":"Lookup type in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentName":{
            "type":"string",
            "description":"Segment name predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "Scale":{
            "type":"string",
            "description":"Scale value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayPrompt":{
            "type":"string",
            "description":"Display prompt in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "type":"string",
            "description":"Code assigned to the attribute in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "HiddenFlag":{
            "type":"boolean",
            "description":"Indicator to hide the configurations in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Precision value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayTypeCode":{
            "type":"string",
            "description":"Code assigned to the display type in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentColumnName":{
            "type":"string",
            "description":"Segment column name predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Required indicator in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        },
        "CheckboxCheckedValue":{
            "type":"string",
            "description":"Predefined value assigned to the DDF attribute when the check box is checked in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumValue":{
            "type":"string",
            "description":"Minimum value predefined for the DDF attribute in the secured regulatory configurations.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislationName":{
            "type":"string",
            "description":"Legislation name in the secured regulatory configurations",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top