Create a section
post
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections
Request
Path Parameters
-
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.
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:2000
Description of the questionnaire section. -
IntroText: string
Title:
Introduction
Maximum Length:2000
Introduction text for the questionnaire section. -
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. -
QuestionOrder: string
Title:
Question Order Code
Maximum Length:30
Default Value:V
Setting that shows the ordering sequence for the questions in a questionnaire section. Valid values include V (Vertical) for presenting the questions in defined sequence and R (Random) for presenting questions in random order. -
questions: 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. -
RandomSampleSize: integer
(int64)
Title:
Sample Size
Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random. -
ResponseOrder: string
Title:
Response Order Code
Maximum Length:30
Default Value:V
Code that shows the ordering sequence for the answer choices in questions included in a questionnaire section. Valid values include V (Vertical) for presenting the answer choices in a question in the defined sequence and R (Random) for presenting answer choices in random order. -
SectionName: string
Title:
Section Name
Maximum Length:240
Name of the questionnaire section. -
SectionSequenceNumber: integer
(int64)
Title:
Section Sequence Number
Sequence number for a section in a questionnaire.
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
Nested Schema : schema
Type:
Show Source
object
-
answers: array
Answers
Title:
Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:30
Default Value:false
Indicates whether the response to this question is mandatory. Participants can't skip this question without an answer. The default value is false. -
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 score limit for the question when the total score is calculated for a response to the question. -
questionAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV. -
QuestionId: integer
(int64)
Title:
Question ID
Surrogate identifier of the question. -
ResponseType: string
Title:
Response Type Code
Maximum Length:30
Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV. -
SequenceNumber: integer
(int64)
Title:
Sequence Number
Sequence number of the question in a questionnaire template section. -
VersionNumber: integer
(int64)
Title:
Version Number
Version number of the question in the questionnaire.
Nested Schema : Answers
Type:
array
Title:
Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-item-post-request
Type:
Show Source
object
-
answerAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
Score: integer
Title:
Score
Score for the answer.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-answerAttachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : questionnaires-sections-questions-questionAttachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
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.
Root Schema : questionnaires-sections-item-response
Type:
Show Source
object
-
AllowAdditionalQuestionsFlag: boolean
Title:
Allow Additional Questions
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether you can include informal or casual questions in a questionnaire section when a response is requested for a questionnaire. The default value is false. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who created the section. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the section was created. -
Description: string
Title:
Description
Maximum Length:2000
Description of the questionnaire section. -
IntroText: string
Title:
Introduction
Maximum Length:2000
Introduction text for the questionnaire section. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the section was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Name of the user who last updated the section. -
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. -
QuestionOrder: string
Title:
Question Order Code
Maximum Length:30
Default Value:V
Setting that shows the ordering sequence for the questions in a questionnaire section. Valid values include V (Vertical) for presenting the questions in defined sequence and R (Random) for presenting questions in random order. -
QuestionOrderMeaning: string
Title:
Question Order
Read Only:true
Maximum Length:80
Meaning of the question order code. -
questions: 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. -
RandomSampleSize: integer
(int64)
Title:
Sample Size
Defines the number of questions presented to the participant of a questionnaire, when the question order is set to random. -
ResponseOrder: string
Title:
Response Order Code
Maximum Length:30
Default Value:V
Code that shows the ordering sequence for the answer choices in questions included in a questionnaire section. Valid values include V (Vertical) for presenting the answer choices in a question in the defined sequence and R (Random) for presenting answer choices in random order. -
ResponseOrderMeaning: string
Title:
Response Order
Read Only:true
Maximum Length:80
Meaning of the response order code. -
SectionId: integer
(int64)
Title:
Section Id
Read Only:true
Surrogate identifier for the section in a questionnaire. -
SectionName: string
Title:
Section Name
Maximum Length:240
Name of the questionnaire section. -
SectionSequenceNumber: integer
(int64)
Title:
Section Sequence Number
Sequence number for a section in a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : questionnaires-sections-questions-item-response
Type:
Show Source
object
-
AdhocQuestion: string
Title:
Casual Question
Read Only:true
Maximum Length:30
Default Value:N
Setting that indicates if the question added to the questionnaire is an informal or a casual question. This is a read-only attribute. -
AllowAdditionalCommentsFlag: boolean
Title:
Allow Additional Comments
Read Only:true
Maximum Length:20
Default Value:false
Indicates whether a participant can provide additional comments while responding to a question. Valid values are Y and N. The default value is N. -
AllowAttachmentsFlag: boolean
Title:
Allow Attachments
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether an attachment is allowed as a response to the question. The default value is N. -
answers: array
Answers
Title:
Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section. -
ConditionalDisplayFlag: boolean
Title:
Conditional Display
Read Only:true
Maximum Length:30
Indicates whether a question conditionally displays. When this is set to Y, the controlling question code and controlling response are mandatory. The default value is N. -
ControllingAnswerCode: string
Title:
Controlling Question Code
Read Only:true
Maximum Length:240
Answer to the controlling question that determines if the question displays or not. -
ControllingAnswerId: integer
(int64)
Title:
Controlling Answer Id
Read Only:true
Surrogate identifier of the controlling question. Required if the conditional display is set to Y. -
ControllingQuestionCode: string
Title:
Controlling Question Code
Read Only:true
Maximum Length:240
Question code for the controlling question that determines if the question is presented to the participant to respond. Valid values are defined in the list questionsLOV. -
ControllingQuestionId: integer
(int64)
Title:
Controlling Question Id
Read Only:true
Surrogate identifier for the controlling question. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the user who added the question to the questionnaire section. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the question was added to the questionnaire section. -
InstructionsText: string
Title:
Instruction Text
Read Only:true
Maximum Length:4000
Instructions or additional information for the question. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the question was last updated in the questionnaire section. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Date when the question was last updated in the questionnaire section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockQuestionFlag: boolean
Title:
Lock Question
Read Only:true
Maximum Length:8
Default Value:false
Indicates whether you can remove or modify the question in the questionnaire. This is a read-only attribute. The default value is false. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:30
Default Value:false
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
Read Only:true
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. -
MaximumResponses: integer
(int64)
Title:
Maximum Number of Selections
Read Only:true
Maximum number of answer choices that a participant can select when responding to a multiple choice question. -
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. -
MinimumResponses: integer
(int64)
Title:
Minimum Number of Selections
Read Only:true
Minimum number of answer choices that a participant can select when responding to a multiple choice question. -
MinimumThresholdScore: integer
(int64)
Title:
Minimum Calculated Score
Minimum score limit for the question when the total score is calculated for a response to the question. -
questionAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Question code for the question used in the questionnaire template section. Valid values are defined in the list questionsLOV. -
QuestionId: integer
(int64)
Title:
Question ID
Surrogate identifier of the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question ID
Read Only:true
Surrogate identifier of the question in the questionnaire. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Question text for the question. -
QuestionType: string
Title:
Question Type Code
Read Only:true
Maximum Length:30
Default Value:TEXT
Question type code indicating the type of the question. -
QuestionTypeMeaning: string
Title:
Question Type
Read Only:true
Maximum Length:80
Meaning of the question type code. -
ResponseMaximumLength: string
Title:
Response Maximum Length
Read Only:true
Maximum Length:20
Maximum allowed length of responses for a text response type. -
ResponseMinimumLength: integer
(int64)
Title:
Response Minimum Length
Read Only:true
Minimum expected length of responses for a text response type. -
ResponseOrder: string
Title:
Response Order Code
Read Only:true
Maximum Length:30
Code that shows if the question is enabled for random order. Possible values are Random to randomize the answer choices and Vertical to present the answer choices in the defined sequence. -
ResponseOrderMeaning: string
Title:
Response Order
Read Only:true
Maximum Length:80
Meaning of the response order code. -
ResponseType: string
Title:
Response Type Code
Maximum Length:30
Response type for the question when presented to the participant. Valid values are defined in the questionnaireResponseTypesLOV. -
ResponseTypeMeaning: string
Title:
Response Type
Read Only:true
Maximum Length:240
Meaning of the response type code. -
SampleSize: integer
(int64)
Title:
Sample Size
Read Only:true
Number of answer choices presented to the participant when responding to a question that's enabled for randomization. -
ScoredFlag: boolean
Title:
Score Question
Read Only:true
Maximum Length:30
Default Value:false
Indicates whether the question is used in calculating the score. The default value is N. -
SequenceNumber: integer
(int64)
Title:
Sequence Number
Sequence number of the question in a questionnaire template section. -
Status: string
Title:
Status Code
Read Only:true
Maximum Length:30
Default Value:D
Status of the question. Valid values are A for Active, I for Inactive and D for Draft. -
VersionNumber: integer
(int64)
Title:
Version Number
Version number of the question in the questionnaire.
Nested Schema : Answers
Type:
array
Title:
Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : questionnaires-sections-questions-answers-item-response
Type:
Show Source
object
-
answerAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer ID
Read Only:true
Surrogate identifier for the answer choice defined for a question. -
ResponseCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
Unique code for the answer choice defined for a question. -
ResponseFeedback: string
(byte)
Title:
Response Feedback
Read Only:true
Feedback provided to the participant when the answer choice is selected. -
Score: integer
Title:
Score
Score for the answer. -
ShortDescription: string
Title:
Short Description
Read Only:true
Maximum Length:2000
Answer text for the answer choices of a question.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaires-sections-questions-answers-answerAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : questionnaires-sections-questions-questionAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- questionOrdersLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_ORDER
The following properties are defined on the LOV link relation:- Source Attribute: QuestionOrder; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder:
- questions
-
Parameters:
- questionnairesUniqID:
$request.path.questionnairesUniqID
- sectionsUniqID:
$request.path.sectionsUniqID
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire. - questionnairesUniqID:
- responseOrdersLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHRQ_QUESTION_ORDER
The following properties are defined on the LOV link relation:- Source Attribute: ResponseOrder; Target Attribute: LookupCode
- Display Attribute: LookupCode
- finder: