Jump to

• Request
• Response

Create an assessment package

post

/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages

Request

Path Parameters

• AssessmentConfigId(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=
• triggersUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AssessmentConfigId, PhaseId, StateId and TriggerType ---for the Assessment Triggers in Job Requisition resource and used to uniquely identify an instance of Assessment Triggers in Job Requisition. The client should not generate the hash key value. Instead, the client should query on the Assessment Triggers in Job Requisition collection resource with a filter on the primary key values in order to navigate to a specific instance of Assessment Triggers in Job Requisition.
  
  For example: triggers?q=AssessmentConfigId=<value1>;PhaseId=<value2>;StateId=<value3>;TriggerType=<value4>

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

• 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(required):
  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(required):
  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-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"
    }
}

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