Jump to

• Request
• Response

Create a request information application flow

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/secondarySubmissions

Request

Path Parameters

• recruitingJobSiteJobApplicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CandidateNumber and RequisitionNumber ---for the Job Applications resource and used to uniquely identify an instance of Job Applications. The client should not generate the hash key value. Instead, the client should query on the Job Applications collection resource with a filter on the primary key values in order to navigate to a specific instance of Job Applications.
  
  For example: recruitingJobSiteJobApplications?q=CandidateNumber=<value1>;RequisitionNumber=<value2>

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

• StepActionUsageId: integer
  Step action usage ID of the request information application flow.

{
    "type":"object",
    "properties":{
        "StepActionUsageId":{
            "type":"integer",
            "description":"Step action usage ID of the request information application flow.",
            "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 : recruitingJobSiteJobApplications-secondarySubmissions-item-response

Type: object

Show Source

• FlowId: integer
  Read Only: true

  Flow ID of the request information application flow.
• links: array Links
  Title: Links

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

  Primary key of the request information application flow.
• StatusCode: string
  Read Only: true

  Maximum Length: 255

  Status code of the request information application flow.
• StepActionUsageId: integer
  Step action usage ID of the request information application flow.
• TriggeredBy: string
  Read Only: true

  Maximum Length: 255

  User who requested the request information application flow.
• TriggeredDate: string (date)
  Read Only: true

  Date and time when the request for more info was triggered.

{
    "type":"object",
    "properties":{
        "FlowId":{
            "type":"integer",
            "description":"Flow ID of the request information application flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriggeredDate":{
            "type":"string",
            "description":"Date and time when the request for more info was triggered.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TriggeredBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who requested the request information application flow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryFlowId":{
            "type":"integer",
            "description":"Primary key of the request information application flow.",
            "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"
            }
        },
        "StepActionUsageId":{
            "type":"integer",
            "description":"Step action usage ID of the request information application flow.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "description":"Status code of the request information application flow.",
            "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