Jump to

• Request
• Response

Update a block in a job application request information flow in Talent Network

patch

/hcmRestApi/resources/11.13.18.05/recruitingTNAdditionalInformationFlows/{AdditionalInformationFlowId}/child/blocks/{AdditionalInformationFlowBlockId}

Request

Path Parameters

• AdditionalInformationFlowBlockId(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=
• AdditionalInformationFlowId(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

• blockDetails: array Recruiting Talent Network Job Application Request Information Block Details
  Title: Recruiting Talent Network Job Application Request Information Block Details

  The blockDetails resource provides details about the blocks used in job application request information flows.

{
    "type":"object",
    "properties":{
        "blockDetails":{
            "title":"Recruiting Talent Network Job Application Request Information Block Details",
            "type":"array",
            "description":"The blockDetails resource provides details about the blocks used in job application request information flows.",
            "items":{
                "$ref":"#/components/schemas/recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-patch-request"
            }
        }
    }
}

Nested Schema : Recruiting Talent Network Job Application Request Information Block Details

Type: array

Title: Recruiting Talent Network Job Application Request Information Block Details

The blockDetails resource provides details about the blocks used in job application request information flows.

Show Source

• Array of: object recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-patch-request

{
    "title":"Recruiting Talent Network Job Application Request Information Block Details",
    "type":"array",
    "description":"The blockDetails resource provides details about the blocks used in job application request information flows.",
    "items":{
        "$ref":"#/components/schemas/recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-patch-request"
    }
}

Nested Schema : recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : recruitingTNAdditionalInformationFlows-blocks-item-response

Type: object

Show Source

• AdditionalInformationFlowBlockId: integer
  Read Only: true

  Identifier of the job application request information flow block in Talent Network.
• AdditionalInformationFlowId: integer
  Read Only: true

  Flow identifier of the job application request information flow block in Talent Network.
• BlockCode: string
  Read Only: true

  Maximum Length: 255

  Code of the job application request information flow block in Talent Network.
• blockDetails: array Recruiting Talent Network Job Application Request Information Block Details
  Title: Recruiting Talent Network Job Application Request Information Block Details

  The blockDetails resource provides details about the blocks used in job application request information flows.
• BlockInstructions: string
  Read Only: true

  Maximum Length: 255

  Instructions of the job application request information flow block in Talent Network.
• BlockProperties: string
  Read Only: true

  Properties of the job application request information flow block in Talent Network.
• BlockTitle: string
  Read Only: true

  Maximum Length: 255

  Title of the job application request information flow block in Talent Network.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "BlockCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformationFlowId":{
            "type":"integer",
            "description":"Flow identifier of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BlockInstructions":{
            "maxLength":255,
            "type":"string",
            "description":"Instructions of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BlockTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BlockProperties":{
            "type":"string",
            "description":"Properties of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformationFlowBlockId":{
            "type":"integer",
            "description":"Identifier of the job application request information flow block in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "blockDetails":{
            "title":"Recruiting Talent Network Job Application Request Information Block Details",
            "type":"array",
            "description":"The blockDetails resource provides details about the blocks used in job application request information flows.",
            "items":{
                "$ref":"#/components/schemas/recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-response"
            }
        }
    }
}

Nested Schema : Recruiting Talent Network Job Application Request Information Block Details

Type: array

Title: Recruiting Talent Network Job Application Request Information Block Details

The blockDetails resource provides details about the blocks used in job application request information flows.

Show Source

• Array of: object recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-response

{
    "title":"Recruiting Talent Network Job Application Request Information Block Details",
    "type":"array",
    "description":"The blockDetails resource provides details about the blocks used in job application request information flows.",
    "items":{
        "$ref":"#/components/schemas/recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-response"
    }
}

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 : recruitingTNAdditionalInformationFlows-blocks-blockDetails-item-response

Type: object

Show Source

• AdditionalInformationFlowBlockDetailsId: integer
  Read Only: true

  Identifier of the job application request information flow block details in Talent Network.
• AdditionalInformationFlowBlockId: integer
  Read Only: true

  Block identifier of the job application request information flow block details in Talent Network.
• AttributeName: string
  Read Only: true

  Maximum Length: 255

  Attribute name of the job application request information flow block details in Talent Network.
• DefaultValue: string
  Read Only: true

  Maximum Length: 255

  Default value of the job application request information flow block details in Talent Network.
• Dictionary: string
  Read Only: true

  Maximum Length: 255

  Dictionary of the job application request information flow block details in Talent Network.
• DisplaySequence: integer
  Read Only: true

  Display sequence of the job application request information flow block details in Talent Network.
• FlowVersionId: string
  Read Only: true

  Maximum Length: 255

  Flow version identifier of the job application request information flow block details in Talent Network.
• KeyFlag: boolean
  Read Only: true

  Indicator of the job application request information flow block details in Talent Network.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumLength: integer
  Read Only: true

  Maximum length of the job application request information flow block details in Talent Network.
• Prompt: string
  Read Only: true

  Maximum Length: 255

  Prompt of the job application request information flow block details in Talent Network.
• ReadOnlyFlag: boolean
  Read Only: true

  Read-only indicator of the job application request information flow block details in Talent Network.
• RequiredFlag: boolean
  Read Only: true

  Required indicator of the job application request information flow block details in Talent Network.
• Type: string
  Read Only: true

  Maximum Length: 255

  Type of the job application request information flow block details in Talent Network.
• UIHiddenFlag: boolean
  Read Only: true

  UI hidden indicator of the job application request information flow block details in Talent Network.

{
    "type":"object",
    "properties":{
        "AdditionalInformationFlowBlockDetailsId":{
            "type":"integer",
            "description":"Identifier of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dictionary":{
            "maxLength":255,
            "type":"string",
            "description":"Dictionary of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FlowVersionId":{
            "maxLength":255,
            "type":"string",
            "description":"Flow version identifier of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInformationFlowBlockId":{
            "type":"integer",
            "description":"Block identifier of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":255,
            "type":"string",
            "description":"Default value of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UIHiddenFlag":{
            "type":"boolean",
            "description":"UI hidden indicator of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumLength":{
            "type":"integer",
            "description":"Maximum length of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":255,
            "type":"string",
            "description":"Attribute name of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "type":"boolean",
            "description":"Required indicator of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Prompt":{
            "maxLength":255,
            "type":"string",
            "description":"Prompt of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyFlag":{
            "type":"boolean",
            "description":"Indicator of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadOnlyFlag":{
            "type":"boolean",
            "description":"Read-only indicator of the job application request information flow block details in Talent Network.",
            "nullable":true,
            "readOnly":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."
        }
    }
}

Links

blockDetails

Operation: /hcmRestApi/resources/11.13.18.05/recruitingTNAdditionalInformationFlows/{AdditionalInformationFlowId}/child/blocks/{AdditionalInformationFlowBlockId}/child/blockDetails

Parameters:

• AdditionalInformationFlowBlockId: $request.path.AdditionalInformationFlowBlockId
• AdditionalInformationFlowId: $request.path.AdditionalInformationFlowId

The blockDetails resource provides details about the blocks used in job application request information flows.

Back to Top