Jump to

• Request
• Response

Update a value of the configuration

patch

/hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations/{SubscriberRuleId}

Request

Path Parameters

• SubscriberRuleId(required): integer
  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: string
  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: string
  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

• ApplyAfterAge: integer
  Period when a rule is applied for a recruiting activity item.
• AsynchronousRuleFlag: boolean
  Maximum Length: 1

  Period when a rule is applied for a recruiting activity item.
• Collaborators: string
  Maximum Length: 255

  Hiring team collaborators.
• HiringManagerEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the rule is assigned to the hiring manager.
• Name: string
  Maximum Length: 255

  Name of the recruiting activity item configuration.
• RecruiterEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the rule is assigned to the recruiter.
• RuleEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether to enable or disable the rule.
• RulePriorityCode: string
  Maximum Length: 255

  Priority code of the activity item.
• RulePriorityMeaning: string
  Maximum Length: 255

  Priority meaning of the activity item.
• SubscriberRuleCode: string
  Maximum Length: 255

  Subscriber rule code associated with the recruiting activity item configuration.
• SubscriberRuleId: integer
  Unique identifier for the subscriber rule.
• SubscriberTypeCode: string
  Maximum Length: 255

  Subscriber type code associated with the recruiting activity item configuration.

{
    "type":"object",
    "properties":{
        "ApplyAfterAge":{
            "type":"integer",
            "description":"Period when a rule is applied for a recruiting activity item.",
            "nullable":true
        },
        "AsynchronousRuleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Period when a rule is applied for a recruiting activity item.",
            "nullable":true
        },
        "Collaborators":{
            "maxLength":255,
            "type":"string",
            "description":"Hiring team collaborators.",
            "nullable":true
        },
        "HiringManagerEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is assigned to the hiring manager.",
            "nullable":true
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the recruiting activity item configuration.",
            "nullable":true
        },
        "RecruiterEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is assigned to the recruiter.",
            "nullable":true
        },
        "RuleEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to enable or disable the rule.",
            "nullable":true
        },
        "RulePriorityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Priority code of the activity item.",
            "nullable":true
        },
        "RulePriorityMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Priority meaning of the activity item.",
            "nullable":true
        },
        "SubscriberRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Subscriber rule code associated with the recruiting activity item configuration.",
            "nullable":true
        },
        "SubscriberRuleId":{
            "type":"integer",
            "description":"Unique identifier for the subscriber rule.",
            "nullable":true
        },
        "SubscriberTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Subscriber type code associated with the recruiting activity item configuration.",
            "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 : recruitingRACConfigurations-item-response

Type: object

Show Source

• ApplyAfterAge: integer
  Period when a rule is applied for a recruiting activity item.
• AsynchronousRuleFlag: boolean
  Maximum Length: 1

  Period when a rule is applied for a recruiting activity item.
• Collaborators: string
  Maximum Length: 255

  Hiring team collaborators.
• HiringManagerEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the rule is assigned to the hiring manager.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 255

  Name of the recruiting activity item configuration.
• RecruiterEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the rule is assigned to the recruiter.
• RuleEnabledFlag: boolean
  Maximum Length: 1

  Indicates whether to enable or disable the rule.
• RulePriorityCode: string
  Maximum Length: 255

  Priority code of the activity item.
• RulePriorityMeaning: string
  Maximum Length: 255

  Priority meaning of the activity item.
• SubscriberRuleCode: string
  Maximum Length: 255

  Subscriber rule code associated with the recruiting activity item configuration.
• SubscriberRuleId: integer
  Unique identifier for the subscriber rule.
• SubscriberTypeCode: string
  Maximum Length: 255

  Subscriber type code associated with the recruiting activity item configuration.

{
    "type":"object",
    "properties":{
        "ApplyAfterAge":{
            "type":"integer",
            "description":"Period when a rule is applied for a recruiting activity item.",
            "nullable":true,
            "x-queryable":true
        },
        "AsynchronousRuleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Period when a rule is applied for a recruiting activity item.",
            "nullable":true,
            "x-queryable":true
        },
        "Collaborators":{
            "maxLength":255,
            "type":"string",
            "description":"Hiring team collaborators.",
            "nullable":true,
            "x-queryable":true
        },
        "HiringManagerEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is assigned to the hiring manager.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the recruiting activity item configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "RecruiterEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is assigned to the recruiter.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to enable or disable the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RulePriorityCode":{
            "maxLength":255,
            "type":"string",
            "description":"Priority code of the activity item.",
            "nullable":true,
            "x-queryable":true
        },
        "RulePriorityMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Priority meaning of the activity item.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberRuleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Subscriber rule code associated with the recruiting activity item configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberRuleId":{
            "type":"integer",
            "description":"Unique identifier for the subscriber rule.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Subscriber type code associated with the recruiting activity item configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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