Jump to

• Request
• Response

Create an assessment configuration for a requisition

post

/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: integer
  Assessment user account identifier.
• AssessmentConfigId: integer
  Assessment configuration identifier.
• ProvisioningId: integer
  Assessment provisioning identifier.
• RequisitionId: integer
  Assessment requisition identifier.
• RequisitionMultiPhaseEnabledFlag: boolean
  Indicates whether the assessment configuration accepts multiple requests for the requisition.
• triggers: array Assessment Triggers in Job Requisition
  Title: Assessment Triggers in Job Requisition

  The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.

{
    "type":"object",
    "properties":{
        "RequisitionId":{
            "type":"integer",
            "description":"Assessment requisition identifier.",
            "nullable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Assessment user account identifier.",
            "nullable":true
        },
        "RequisitionMultiPhaseEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment configuration accepts multiple requests for the requisition.",
            "nullable":true
        },
        "AssessmentConfigId":{
            "type":"integer",
            "description":"Assessment configuration identifier.",
            "nullable":true
        },
        "triggers":{
            "title":"Assessment Triggers in Job Requisition",
            "type":"array",
            "description":"The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-item-post-request"
            }
        },
        "ProvisioningId":{
            "type":"integer",
            "description":"Assessment provisioning identifier.",
            "nullable":true
        }
    }
}

Nested Schema : Assessment Triggers in Job Requisition

Type: array

Title: Assessment Triggers in Job Requisition

The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.

Show Source

• Array of: object recruitingUIRequisitionAssessmentsConfigs-triggers-item-post-request

{
    "title":"Assessment Triggers in Job Requisition",
    "type":"array",
    "description":"The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-item-post-request"
    }
}

Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-item-post-request

Type: object

Show Source

• packages: array Assessment Trigger Packages in Job Requisition
  Title: Assessment Trigger Packages in Job Requisition

  The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.
• PhaseId: integer
  Assessment trigger phase identifier.
• StateId: integer
  Assessment trigger state identifier.
• TriggerType: string
  Maximum Length: 255

  Assessment trigger type.

{
    "type":"object",
    "properties":{
        "StateId":{
            "type":"integer",
            "description":"Assessment trigger state identifier.",
            "nullable":true
        },
        "PhaseId":{
            "type":"integer",
            "description":"Assessment trigger phase identifier.",
            "nullable":true
        },
        "TriggerType":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment trigger type.",
            "nullable":true
        },
        "packages":{
            "title":"Assessment Trigger Packages in Job Requisition",
            "type":"array",
            "description":"The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-post-request"
            }
        }
    }
}

Nested Schema : Assessment Trigger Packages in Job Requisition

Type: array

Title: Assessment Trigger Packages in Job Requisition

The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.

Show Source

• Array of: object recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-post-request

{
    "title":"Assessment Trigger Packages in Job Requisition",
    "type":"array",
    "description":"The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-post-request"
    }
}

Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-post-request

Type: object

Show Source

• PackageId: integer
  Assessment package identifier associated to triggers.

{
    "type":"object",
    "properties":{
        "PackageId":{
            "type":"integer",
            "description":"Assessment package identifier associated to triggers.",
            "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 : recruitingUIRequisitionAssessmentsConfigs-item-response

Type: object

Show Source

• AccountActiveFlag: boolean
  Read Only: true

  Indicates whether the assessment user account is active or not.
• AccountDescription: string
  Read Only: true

  Maximum Length: 255

  Assessment user account description.
• AccountId: integer
  Assessment user account identifier.
• AccountName: string
  Read Only: true

  Maximum Length: 255

  Assessment user account name.
• AssessmentConfigId: integer
  Assessment configuration identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartnerActiveFlag: boolean
  Read Only: true

  Indicates whether the assessment partner is active or not.
• PartnerMultiPhaseSupportFlag: boolean
  Read Only: true

  Indicates whether the assessment partner supports multiple requests or not.
• PartnerName: string
  Read Only: true

  Maximum Length: 255

  Assessment partner name.
• ProvisioningId: integer
  Assessment provisioning identifier.
• RequisitionId: integer
  Assessment requisition identifier.
• RequisitionMultiPhaseEnabledFlag: boolean
  Indicates whether the assessment configuration accepts multiple requests for the requisition.
• SupportedPhaseCount: integer
  Read Only: true

  Indicates the number of triggers supported by the assessment partner.
• triggers: array Assessment Triggers in Job Requisition
  Title: Assessment Triggers in Job Requisition

  The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment user account description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Assessment user account identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment partner name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerMultiPhaseSupportFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment partner supports multiple requests or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "triggers":{
            "title":"Assessment Triggers in Job Requisition",
            "type":"array",
            "description":"The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-item-response"
            }
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Assessment requisition identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment partner is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment user account is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportedPhaseCount":{
            "type":"integer",
            "description":"Indicates the number of triggers supported by the assessment partner.",
            "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"
            }
        },
        "RequisitionMultiPhaseEnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment configuration accepts multiple requests for the requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentConfigId":{
            "type":"integer",
            "description":"Assessment configuration identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ProvisioningId":{
            "type":"integer",
            "description":"Assessment provisioning identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountName":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment user account name.",
            "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 : Assessment Triggers in Job Requisition

Type: array

Title: Assessment Triggers in Job Requisition

The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.

Show Source

• Array of: object recruitingUIRequisitionAssessmentsConfigs-triggers-item-response

{
    "title":"Assessment Triggers in Job Requisition",
    "type":"array",
    "description":"The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-item-response"
    }
}

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."
        }
    }
}

Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-item-response

Type: object

Show Source

• AllowedPackageCount: integer
  Read Only: true

  Indicates whether the assessment trigger accepts multiple packages or not.
• AssessmentConfigId: integer
  Read Only: true

  Assessment trigger configuration identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• packages: array Assessment Trigger Packages in Job Requisition
  Title: Assessment Trigger Packages in Job Requisition

  The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.
• PhaseId: integer
  Assessment trigger phase identifier.
• StateId: integer
  Assessment trigger state identifier.
• TriggerActiveFlag: boolean
  Read Only: true

  Indicates whether the assessment trigger is active or not.
• TriggerName: string
  Read Only: true

  Maximum Length: 255

  Assessment trigger name.
• TriggerSequence: integer
  Read Only: true

  Assessment trigger sequence.
• TriggerType: string
  Maximum Length: 255

  Assessment trigger type.

{
    "type":"object",
    "properties":{
        "PhaseId":{
            "type":"integer",
            "description":"Assessment trigger phase identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerType":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment trigger type.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerSequence":{
            "type":"integer",
            "description":"Assessment trigger sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriggerName":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment trigger name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowedPackageCount":{
            "type":"integer",
            "description":"Indicates whether the assessment trigger accepts multiple packages or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StateId":{
            "type":"integer",
            "description":"Assessment trigger state identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TriggerActiveFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment trigger is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessmentConfigId":{
            "type":"integer",
            "description":"Assessment trigger configuration identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "packages":{
            "title":"Assessment Trigger Packages in Job Requisition",
            "type":"array",
            "description":"The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-packages-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 : Assessment Trigger Packages in Job Requisition

Type: array

Title: Assessment Trigger Packages in Job Requisition

The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.

Show Source

• Array of: object recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-response

{
    "title":"Assessment Trigger Packages in Job Requisition",
    "type":"array",
    "description":"The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-response"
    }
}

Nested Schema : recruitingUIRequisitionAssessmentsConfigs-triggers-packages-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PackageCode: string
  Read Only: true

  Maximum Length: 255

  Assessment package code associated to triggers.
• PackageDescription: string
  Read Only: true

  Maximum Length: 255

  Assessment package description associated to triggers.
• PackageId: integer
  Assessment package identifier associated to triggers.
• PackageName: string
  Read Only: true

  Maximum Length: 255

  Assessment package name associated to triggers.
• PackageSequence: integer
  Read Only: true

  Assessment package sequence within a trigger.
• PackageValidFlag: boolean
  Read Only: true

  Indicates whether the assessment package is active or not.

{
    "type":"object",
    "properties":{
        "PackageSequence":{
            "type":"integer",
            "description":"Assessment package sequence within a trigger.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackageName":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment package name associated to triggers.",
            "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"
            }
        },
        "PackageId":{
            "type":"integer",
            "description":"Assessment package identifier associated to triggers.",
            "nullable":true,
            "x-queryable":true
        },
        "PackageCode":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment package code associated to triggers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackageValidFlag":{
            "type":"boolean",
            "description":"Indicates whether the assessment package is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PackageDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Assessment package description associated to triggers.",
            "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"
    }
}

Links

triggers

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers

Parameters:

• AssessmentConfigId: $request.path.AssessmentConfigId

The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.

Back to Top