Jump to

• Request
• Response

Create a question

post

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/{EventNumber}/child/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionDetails

Request

Path Parameters

• EventNumber(required): string
  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=
• questionnairesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questionnaires resource and used to uniquely identify an instance of Questionnaires. The client should not generate the hash key value. Instead, the client should query on the Questionnaires collection resource in order to navigate to a specific instance of Questionnaires to get the hash key.
• questionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questions resource and used to uniquely identify an instance of Questions. The client should not generate the hash key value. Instead, the client should query on the Questions collection resource in order to navigate to a specific instance of Questions to get the hash key.
• sectionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sections resource and used to uniquely identify an instance of Sections. The client should not generate the hash key value. Instead, the client should query on the Sections collection resource in order to navigate to a specific instance of Sections to get the hash key.

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowAttachmentsFlag: boolean
  Title: Allow attachments

  Maximum Length: 30

  Default Value: false

  Indicates whether an attachment is allowed as a response to the question.
• CategoryId: integer (int64)
  Title: Folder

  Surrogate identifier of the folder where the question is stored.
• InstructionsText: string
  Maximum Length: 4000

  Instructions or additional information for the question.
• LatestVersion: string
  Title: Latest Version

  Maximum Length: 30

  Default Value: N

  Setting that indicates if this is the latest version of the question. This is a read-only attribute.
• Owner: string
  Title: Owner

  Maximum Length: 64

  Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
• PrivacyFlag: boolean
  Title: Privacy

  Maximum Length: 30

  Default Value: false

  Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
• QuestionCode: string
  Title: Question Code

  Maximum Length: 240

  Alphanumeric value that uniquely identifies a question defined for a subscriber.
• QuestionId: integer (int64)
  Title: Question Code

  Surrogate identifier for the question.
• QuestionText: string
  Title: Question Text

  Maximum Length: 2000

  Text of the question being asked.
• QuestionType: string
  Title: Question Type

  Maximum Length: 30

  Default Value: TEXT

  Code identifying the type of question. Valid values are in the list commonLookupsLOV.
• QuestionVersionNumber: integer (int64)
  Title: Question Version Number

  Default Value: 1

  Version number of the question. New questions must have a version number of 1.
• ResponseTypeId: integer (int64)
  Title: Response Type

  Default Value: 1

  Surrogate identifier of the response type for the question.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: D

  Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
• SubscriberId: integer (int64)
  Title: Subscriber

  Surrogate identifier for the subscriber.

{
    "type":"object",
    "properties":{
        "AllowAttachmentsFlag":{
            "title":"Allow attachments",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether an attachment is allowed as a response to the question.",
            "nullable":true,
            "default":false
        },
        "CategoryId":{
            "title":"Folder",
            "type":"integer",
            "description":"Surrogate identifier of the folder where the question is stored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InstructionsText":{
            "maxLength":4000,
            "type":"string",
            "description":"Instructions or additional information for the question.",
            "nullable":true
        },
        "LatestVersion":{
            "title":"Latest Version",
            "maxLength":30,
            "type":"string",
            "description":"Setting that indicates if this is the latest version of the question. This is a read-only attribute.",
            "nullable":true,
            "default":"N"
        },
        "Owner":{
            "title":"Owner",
            "maxLength":64,
            "type":"string",
            "description":"Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.",
            "nullable":true
        },
        "PrivacyFlag":{
            "title":"Privacy",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.",
            "nullable":false,
            "default":false
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false
        },
        "QuestionId":{
            "title":"Question Code",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question being asked.",
            "nullable":true
        },
        "QuestionType":{
            "title":"Question Type",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying the type of question. Valid values are in the list commonLookupsLOV.",
            "nullable":false,
            "default":"TEXT"
        },
        "QuestionVersionNumber":{
            "title":"Question Version Number",
            "type":"integer",
            "description":"Version number of the question. New questions must have a version number of 1.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseTypeId":{
            "title":"Response Type",
            "type":"integer",
            "description":"Surrogate identifier of the response type for the question.",
            "format":"int64",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the question. Valid values are A for Active, I for Inactive and D for Draft.",
            "nullable":false,
            "default":"D"
        },
        "SubscriberId":{
            "title":"Subscriber",
            "type":"integer",
            "description":"Surrogate identifier for the subscriber.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : communicateUIEmployeeEventDetails-questionnaires-sections-questions-questionDetails-item-response

Type: object

Show Source

• AllowAttachmentsFlag: boolean
  Title: Allow attachments

  Maximum Length: 30

  Default Value: false

  Indicates whether an attachment is allowed as a response to the question.
• CategoryId: integer (int64)
  Title: Folder

  Surrogate identifier of the folder where the question is stored.
• InstructionsText: string
  Maximum Length: 4000

  Instructions or additional information for the question.
• LatestVersion: string
  Title: Latest Version

  Maximum Length: 30

  Default Value: N

  Setting that indicates if this is the latest version of the question. This is a read-only attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Owner: string
  Title: Owner

  Maximum Length: 64

  Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
• PrivacyFlag: boolean
  Title: Privacy

  Maximum Length: 30

  Default Value: false

  Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
• QuestionCode: string
  Title: Question Code

  Maximum Length: 240

  Alphanumeric value that uniquely identifies a question defined for a subscriber.
• QuestionId: integer (int64)
  Title: Question Code

  Surrogate identifier for the question.
• QuestionText: string
  Title: Question Text

  Maximum Length: 2000

  Text of the question being asked.
• QuestionType: string
  Title: Question Type

  Maximum Length: 30

  Default Value: TEXT

  Code identifying the type of question. Valid values are in the list commonLookupsLOV.
• QuestionVersionNumber: integer (int64)
  Title: Question Version Number

  Default Value: 1

  Version number of the question. New questions must have a version number of 1.
• ResponseTypeId: integer (int64)
  Title: Response Type

  Default Value: 1

  Surrogate identifier of the response type for the question.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: D

  Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
• SubscriberId: integer (int64)
  Title: Subscriber

  Surrogate identifier for the subscriber.

{
    "type":"object",
    "properties":{
        "AllowAttachmentsFlag":{
            "title":"Allow attachments",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether an attachment is allowed as a response to the question.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Folder",
            "type":"integer",
            "description":"Surrogate identifier of the folder where the question is stored.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstructionsText":{
            "maxLength":4000,
            "type":"string",
            "description":"Instructions or additional information for the question.",
            "nullable":true,
            "x-queryable":true
        },
        "LatestVersion":{
            "title":"Latest Version",
            "maxLength":30,
            "type":"string",
            "description":"Setting that indicates if this is the latest version of the question. This is a read-only attribute.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":64,
            "type":"string",
            "description":"Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.",
            "nullable":true,
            "x-queryable":true
        },
        "PrivacyFlag":{
            "title":"Privacy",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question Code",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question being asked.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionType":{
            "title":"Question Type",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying the type of question. Valid values are in the list commonLookupsLOV.",
            "nullable":false,
            "default":"TEXT",
            "x-queryable":true
        },
        "QuestionVersionNumber":{
            "title":"Question Version Number",
            "type":"integer",
            "description":"Version number of the question. New questions must have a version number of 1.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseTypeId":{
            "title":"Response Type",
            "type":"integer",
            "description":"Surrogate identifier of the response type for the question.",
            "format":"int64",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the question. Valid values are A for Active, I for Inactive and D for Draft.",
            "nullable":false,
            "default":"D",
            "x-queryable":true
        },
        "SubscriberId":{
            "title":"Subscriber",
            "type":"integer",
            "description":"Surrogate identifier for the subscriber.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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