Jump to

• Request
• Response

Get a questionnaire

get

/hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/{EventNumber}/child/questionnaires/{questionnairesUniqID}

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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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-item-response

Type: object

Show Source

• InUse: string
  Title: In Use

  Maximum Length: 30

  Default Value: N

  Code that shows whether the participants have already responded to the questionnaire.
• LatestVersion: string
  Title: Latest Version

  Maximum Length: 30

  Default Value: N

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

  The link relations associated with the resource instance.
• MaximumPossibleScore: integer (int64)
  Title: Maximum Possible Score

  Sum of the maximum possible scores of all questions that are included in the questionnaire.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the questionnaire.
• QuestionnaireCode: string
  Title: Questionnaire Code

  Maximum Length: 240

  Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
• QuestionnaireId: integer (int64)
  Title: Questionnaire ID

  Surrogate identifier of the questionnaire.
• QuestionnaireVersionNumber: integer (int64)
  Title: Questionnaire Version Number

  Default Value: 1

  Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.
• ScoreQuestionnaire: string
  Title: Score Questionnaire

  Maximum Length: 30

  Setting that indicates if the questionnaire is scored. This is a read-only attribute.
• sections: array Sections
  Title: Sections

  The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.

{
    "type":"object",
    "properties":{
        "InUse":{
            "title":"In Use",
            "maxLength":30,
            "type":"string",
            "description":"Code that shows whether the participants have already responded to the questionnaire.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LatestVersion":{
            "title":"Latest Version",
            "maxLength":30,
            "type":"string",
            "description":"Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Sum of the maximum possible scores of all questions that are included in the questionnaire.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the questionnaire.",
            "nullable":false,
            "x-queryable":true
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.",
            "nullable":false,
            "x-queryable":true
        },
        "QuestionnaireId":{
            "title":"Questionnaire ID",
            "type":"integer",
            "description":"Surrogate identifier of the questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version Number",
            "type":"integer",
            "description":"Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScoreQuestionnaire":{
            "title":"Score Questionnaire",
            "maxLength":30,
            "type":"string",
            "description":"Setting that indicates if the questionnaire is scored. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "sections":{
            "title":"Sections",
            "type":"array",
            "description":"The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-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 : Sections

Type: array

Title: Sections

The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.

Show Source

• Array of: object communicateUIEmployeeEventDetails-questionnaires-sections-item-response

{
    "title":"Sections",
    "type":"array",
    "description":"The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-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 : communicateUIEmployeeEventDetails-questionnaires-sections-item-response

Type: object

Show Source

• links: array Links
  Title: Links

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

  Maximum Length: 30

  Default Value: N

  Indicates whether the questionnaire section is mandatory. Valid values are Y and N. The default value is N.
• Name: string
  Title: Title

  Maximum Length: 240

  Name of the questionnaire section.
• QuestionnaireSectionId: integer (int64)
  Title: Questionnaire Section ID

  Surrogate identifier for the section in a questionnaire.
• questions: array Questions
  Title: Questions

  The child resource for questionnaire questions.
• SectionSequenceNumber: integer (int64)
  Title: Section Sequence Number

  Sequence number for a section in a questionnaire.

{
    "type":"object",
    "properties":{
        "Mandatory":{
            "title":"Required",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the questionnaire section is mandatory. Valid values are Y and N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "Name":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Name of the questionnaire section.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireSectionId":{
            "title":"Questionnaire Section ID",
            "type":"integer",
            "description":"Surrogate identifier for the section in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SectionSequenceNumber":{
            "title":"Section Sequence Number",
            "type":"integer",
            "description":"Sequence number for a section in a questionnaire.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "questions":{
            "title":"Questions",
            "type":"array",
            "description":"The child resource for questionnaire questions.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-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 : Questions

Type: array

Title: Questions

The child resource for questionnaire questions.

Show Source

• Array of: object communicateUIEmployeeEventDetails-questionnaires-sections-questions-item-response

{
    "title":"Questions",
    "type":"array",
    "description":"The child resource for questionnaire questions.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-item-response"
    }
}

Nested Schema : communicateUIEmployeeEventDetails-questionnaires-sections-questions-item-response

Type: object

Show Source

• AllowAttachmentsFlag: boolean
  Indicates whether an attachment is allowed as a response to the question.
• answers: array Answers
  Title: Answers

  The child resource for questionnaire question answers.
• CategoryId: integer
  Surrogate identifier of the folder where the question is stored.
• ClassificationTypeMeaning: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  Meaning of the classification code.
• ConditionQuestionId: integer (int64)
  Title: Controlling Question Id

  Read Only: true

  Surrogate identifier of the controlling question. Required if the conditional display is set to Y.
• ConditionQuestionVersionNumber: integer (int64)
  Read Only: true

  Version number of the question. New questions must have a version number of 1.
• InstructionsText: string
  Instructions or additional information for the question.
• LatestVersion: string
  Title: Latest Version

  Read Only: true

  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.
• Mandatory: string
  Title: Mandatory

  Maximum Length: 30

  Default Value: N

  Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.
• MandatoryMeaning: string
  Title: Response Required

  Read Only: true

  Maximum Length: 80

  Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.
• MaximumPossibleScore: integer (int64)
  Title: Maximum Possible Score

  Maximum possible score which is the sum of the maximum possible scores of the possible answer choices. This can be zero if none of the answer choices have a positive score defined.
• MaximumThresholdScore: integer (int64)
  Title: Maximum Calculated Score

  Maximum score limit for the question when the total score is calculated for a response to the question.
• MinimumThresholdScore: integer (int64)
  Title: Minimum Calculated Score

  Minimum number of answer choices that a participant can select when responding to a multiple choice question.
• Owner: string
  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
  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: Code

  Read Only: true

  Maximum Length: 240

  Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.
• questionDetails: array Questions
  Title: Questions

  The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
• QuestionId: integer (int64)
  Title: Question ID

  Surrogate identifier of the question.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question ID

  Surrogate identifier of the question in the questionnaire.
• QuestionText: string
  Question text for the question.
• QuestionType: string
  Question type code indicating the type of the question.
• QuestionTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the question type code.
• QuestionVersionNumber: integer (int64)
  Title: Version

  Version number of the question. New questions must have a version number of 1.
• ResponseTypeId: integer
  Surrogate identifier of the response type for the question.
• ScoreQuestion: string
  Title: Score Question

  Read Only: true

  Maximum Length: 30

  Indicates whether the question is used in calculating the score. The default value is N.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence number of a question in the questionnaire and section definitions.
• Status: string
  Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
• SubscriberId: integer
  Surrogate identifier for the subscriber.

{
    "type":"object",
    "properties":{
        "AllowAttachmentsFlag":{
            "type":"boolean",
            "description":"Indicates whether an attachment is allowed as a response to the question.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Surrogate identifier of the folder where the question is stored.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationTypeMeaning":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the classification code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionQuestionId":{
            "title":"Controlling Question Id",
            "type":"integer",
            "description":"Surrogate identifier of the controlling question. Required if the conditional display is set to Y.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConditionQuestionVersionNumber":{
            "type":"integer",
            "description":"Version number of the question. New questions must have a version number of 1.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstructionsText":{
            "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,
            "readOnly":true,
            "default":"N",
            "x-queryable":true
        },
        "Mandatory":{
            "title":"Mandatory",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "MandatoryMeaning":{
            "title":"Response Required",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumPossibleScore":{
            "title":"Maximum Possible Score",
            "type":"integer",
            "description":"Maximum possible score which is the sum of the maximum possible scores of the possible answer choices. This can be zero if none of the answer choices have a positive score defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumThresholdScore":{
            "title":"Maximum Calculated Score",
            "type":"integer",
            "description":"Maximum score limit for the question when the total score is calculated for a response to the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MinimumThresholdScore":{
            "title":"Minimum Calculated Score",
            "type":"integer",
            "description":"Minimum number of answer choices that a participant can select when responding to a multiple choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Owner":{
            "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":{
            "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":true,
            "x-queryable":true
        },
        "QuestionCode":{
            "title":"Code",
            "maxLength":240,
            "type":"string",
            "description":"Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionId":{
            "title":"Question ID",
            "type":"integer",
            "description":"Surrogate identifier of the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionText":{
            "type":"string",
            "description":"Question text for the question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionType":{
            "type":"string",
            "description":"Question type code indicating the type of the question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the question type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionVersionNumber":{
            "title":"Version",
            "type":"integer",
            "description":"Version number of the question. New questions must have a version number of 1.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question ID",
            "type":"integer",
            "description":"Surrogate identifier of the question in the questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseTypeId":{
            "type":"integer",
            "description":"Surrogate identifier of the response type for the question.",
            "nullable":true,
            "x-queryable":true
        },
        "ScoreQuestion":{
            "title":"Score Question",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the question is used in calculating the score. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence number of a question in the questionnaire and section definitions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the question. Valid values are A for Active, I for Inactive and D for Draft.",
            "nullable":true,
            "x-queryable":true
        },
        "SubscriberId":{
            "type":"integer",
            "description":"Surrogate identifier for the subscriber.",
            "nullable":true,
            "x-queryable":true
        },
        "answers":{
            "title":"Answers",
            "type":"array",
            "description":"The child resource for questionnaire question answers.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-answers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionDetails":{
            "title":"Questions",
            "type":"array",
            "description":"The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.",
            "items":{
                "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-questionDetails-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Answers

Type: array

Title: Answers

The child resource for questionnaire question answers.

Show Source

• Array of: object communicateUIEmployeeEventDetails-questionnaires-sections-questions-answers-item-response

{
    "title":"Answers",
    "type":"array",
    "description":"The child resource for questionnaire question answers.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-answers-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 : Questions

Type: array

Title: Questions

The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.

Show Source

• Array of: object communicateUIEmployeeEventDetails-questionnaires-sections-questions-questionDetails-item-response

{
    "title":"Questions",
    "type":"array",
    "description":"The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.",
    "items":{
        "$ref":"#/components/schemas/communicateUIEmployeeEventDetails-questionnaires-sections-questions-questionDetails-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : communicateUIEmployeeEventDetails-questionnaires-sections-questions-answers-item-response

Type: object

Show Source

• AnswerCode: string
  Title: Response Code

  Maximum Length: 240

  Unique code for the answer choice defined for a question.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongText: string
  Title: Long Text

  Maximum Length: 2000

  Answer text for the answer choices of a question.
• QuestionAnswerId: integer (int64)
  Title: Question Answer ID

  Surrogate identifier for the answer choice defined for a question.
• SequenceNumber: integer (int64)
  Title: Sequence Number

  Sequence in which the answer choice is presented during response by a participant.

{
    "type":"object",
    "properties":{
        "AnswerCode":{
            "title":"Response Code",
            "maxLength":240,
            "type":"string",
            "description":"Unique code for the answer choice defined for a question.",
            "nullable":true,
            "x-queryable":true
        },
        "LongText":{
            "title":"Long Text",
            "maxLength":2000,
            "type":"string",
            "description":"Answer text for the answer choices of a question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer ID",
            "type":"integer",
            "description":"Surrogate identifier for the answer choice defined for a question.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"Sequence in which the answer choice is presented during response by a participant.",
            "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 : 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"
    }
}

Links

getMetadata

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/{EventNumber}/child/questionnaires/{questionnairesUniqID}/action/getMetadata

Parameters:

• EventNumber: $request.path.EventNumber
• questionnairesUniqID: $request.path.questionnairesUniqID

Gets the questionnaire setup which includes the data related to sections, questions, and corresponding responses.

sections

Operation: /hcmRestApi/resources/11.13.18.05/communicateUIEmployeeEventDetails/{EventNumber}/child/questionnaires/{questionnairesUniqID}/child/sections

Parameters:

• EventNumber: $request.path.EventNumber
• questionnairesUniqID: $request.path.questionnairesUniqID

The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.

Back to Top