Jump to

• Request
• Response

Get all questionnaire participants

get

/hcmRestApi/resources/11.13.18.05/questionnaireParticipants

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all questionnaire participants that match the primary key specified.
    Finder Variables
    • QuestionnaireParticipantId; integer; Surrogate identifier for the questionnaire participant.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • CreatedBy; string; Name of the user who created the questionnaire participant.
  • CreationDate; string; Date and time when the questionnaire participant was created.
  • LastUpdateDate; string; Date and time when the questionnaire participant was last updated.
  • LastUpdatedBy; string; Name of the user who last updated the questionnaire participant.
  • ParticipantId; string; Identifier for the participant responding to the questionnaire. Person identifier is the participant ID for General Surveys subscriber.
  • QuestionnaireCode; string; Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber.
  • QuestionnaireId; integer; Surrogate identifier for the questionnaire that's assigned to the participant.
  • QuestionnaireName; string; Name of the questionnaire that a participant has responded to.
  • QuestionnaireParticipantId; integer; Surrogate identifier for the questionnaire participant.
  • SubscriberCode; string; Alpha numeric value which uniquely identifies a subscriber. Valid values include GSVY for General Surveys subscriber.
  • SubscriberId; integer; Surrogate identifier for subscriber.
  • SubscriberName; string; Name of the subscriber. Valid values include General Surveys.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

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 : questionnaireParticipants

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/questionnaireParticipants-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "isCompactViewByDefault":true
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object questionnaireParticipants-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/questionnaireParticipants-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 : questionnaireParticipants-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the questionnaire participant.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the questionnaire participant was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the questionnaire participant was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the questionnaire participant.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantId: string
  Title: Participant Id

  Maximum Length: 240

  Identifier for the participant responding to the questionnaire. Person identifier is the participant ID for General Surveys subscriber.
• ParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 2000

  Name of the participant (person name) responding to the questionnaire.
• ParticipantNumber: string
  Title: Participant Number

  Maximum Length: 30

  Person number of the participant responding to the questionnaire.
• ParticipantType: string
  Title: Participant Type

  Read Only: true

  Maximum Length: 30

  Default Value: PERSON

  Type of the participant. Valid values include PERSON for General Surveys subscriber.
• QuestionnaireCode: string
  Title: Questionnaire Code

  Maximum Length: 240

  Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber.
• QuestionnaireId: integer (int64)
  Title: Questionnaire Id

  Surrogate identifier for the questionnaire that's assigned to the participant.
• QuestionnaireName: string
  Title: Questionnaire Name

  Read Only: true

  Maximum Length: 240

  Name of the questionnaire that a participant has responded to.
• QuestionnaireParticipantId: integer (int64)
  Title: Questionnaire Participant Id

  Surrogate identifier for the questionnaire participant.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
• Status: string
  Title: Participant Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: I

  Status of the questionnaire participant. For General Surveys subscriber, this value is I to denote a status of in progress.
• StatusMeaning: string
  Title: Participant Status

  Read Only: true

  Maximum Length: 80

  Status of the questionnaire participant.
• SubscriberCode: string
  Title: Subscriber Code

  Maximum Length: 30

  Alpha numeric value which uniquely identifies a subscriber. Valid values include GSVY for General Surveys subscriber.
• SubscriberId: integer (int64)
  Title: Subscriber Id

  Surrogate identifier for subscriber.
• SubscriberName: string
  Title: Subscriber Name

  Maximum Length: 240

  Name of the subscriber. Valid values include General Surveys.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Participant Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire participant. For General Surveys subscriber, this value is I to denote a status of in progress.",
            "nullable":true,
            "readOnly":true,
            "default":"I",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the questionnaire participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the questionnaire participant was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the questionnaire participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":2000,
            "type":"string",
            "description":"Name of the participant (person name) responding to the questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "QuestionnaireParticipantId":{
            "title":"Questionnaire Participant Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Id",
            "maxLength":240,
            "type":"string",
            "description":"Identifier for the participant responding to the questionnaire. Person identifier is the participant ID for General Surveys subscriber.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Participant Status",
            "maxLength":80,
            "type":"string",
            "description":"Status of the questionnaire participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-item-response"
            }
        },
        "ParticipantNumber":{
            "title":"Participant Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number of the participant responding to the questionnaire.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            }
        },
        "SubscriberCode":{
            "title":"Subscriber Code",
            "maxLength":30,
            "type":"string",
            "description":"Alpha numeric value which uniquely identifies a subscriber. Valid values include GSVY for General Surveys subscriber.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SubscriberId":{
            "title":"Subscriber Id",
            "type":"integer",
            "description":"Surrogate identifier for subscriber.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "QuestionnaireId":{
            "title":"Questionnaire Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire that's assigned to the participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriberName":{
            "title":"Subscriber Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the subscriber. Valid values include General Surveys.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionnaireName":{
            "title":"Questionnaire Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the questionnaire that a participant has responded to.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ParticipantType":{
            "title":"Participant Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of the participant. Valid values include PERSON for General Surveys subscriber.",
            "nullable":true,
            "readOnly":true,
            "default":"PERSON",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the questionnaire participant was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "QuestionnaireCode":{
            "title":"Questionnaire Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value which uniquely identifies a questionnaire defined for a subscriber.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "SubscriberId"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Questionnaire Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.

Show Source

• Array of: object questionnaireParticipants-questionnaireResponses-item-response

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-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 : questionnaireParticipants-questionnaireResponses-item-response

Type: object

Show Source

• AttemptNumber: integer (int64)
  Title: Attempt Number

  Read Only: true

  Attempt number by the participant in responding to a questionnaire.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the questionnaire response.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the questionnaire response was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the questionnaire response was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the questionnaire response.
• LatestAttemptFlag: boolean
  Title: Latest Attempt

  Read Only: true

  Maximum Length: 30

  Default Value: false

  Setting that indicates if this is the latest response attempt by a participant to the questionnaire. This is a read-only attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionnaireResponseId: integer (int64)
  Title: Questionnaire Response Id

  Surrogate identifier for the questionnaire response.
• QuestionnaireVersionNumber: integer (int64)
  Title: Questionnaire Version

  Version number of the questionnaire that the participant responds to.
• questionResponses: array Question Responses
  Title: Question Responses

  The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
• Status: string
  Title: Response Status Code

  Maximum Length: 30

  Status of the questionnaire response. I denotes the response is In progress and isn't submitted yet, while S denotes a submitted response.
• StatusMeaning: string
  Title: Response Status

  Read Only: true

  Maximum Length: 80

  Meaning of the status code.
• SubmittedDateTime: string (date)
  Title: Submitted Time

  Read Only: true

  Date on which the questionnaire response was submitted.
• TotalScore: number
  Title: Total Score

  Read Only: true

  Total score for the responses submitted by the participant to a questionnaire.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Response Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is In progress and isn't submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttemptNumber":{
            "title":"Attempt Number",
            "type":"integer",
            "description":"Attempt number by the participant in responding to a questionnaire.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestAttemptFlag":{
            "title":"Latest Attempt",
            "maxLength":30,
            "type":"boolean",
            "description":"Setting that indicates if this is the latest response attempt by a participant to the questionnaire. This is a read-only attribute.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SubmittedDateTime":{
            "title":"Submitted Time",
            "type":"string",
            "description":"Date on which the questionnaire response was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-questionResponses-item-response"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionnaireResponseId":{
            "title":"Questionnaire Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Response Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalScore":{
            "title":"Total Score",
            "type":"number",
            "description":"Total score for the responses submitted by the participant to a questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "scale":2
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the questionnaire response was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Question Responses

Type: array

Title: Question Responses

The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.

Show Source

• Array of: object questionnaireParticipants-questionnaireResponses-questionResponses-item-response

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : questionnaireParticipants-questionnaireResponses-questionResponses-item-response

Type: object

Show Source

• AnswerCode: string
  Title: Answer Code

  Maximum Length: 240

  Code of the answer that a participant chose when responding to a single choice question.
• AnswerCodeList: string
  Title: Answer Code List

  Concatenated list of answer choices (separated by a delimiter) selected by the participant when responding to a multiple choice question.
• AnswerComments: string
  Title: Comments

  Maximum Length: 4000

  Additional comments provided by the participant when responding to a question.
• AnswerLargeObject: string (byte)
  Title: Answer

  Attachment provided by the participant to respond to the question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.
• AnswerShortdescription: string
  Title: Answer Short Description

  Read Only: true

  Maximum Length: 240

  Text of the answer chosen by a participant when responding to a single choice question.
• AnswerShortDescriptionList: string
  Title: Answer Short Description

  Read Only: true

  Concatenated list of answer texts (separated by a delimiter) selected by the participant when responding to a multiple choice question.
• ChoiceCodeList: string
  Title: Choice List Code

  Concatenated list of answer codes (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.
• ChoiceList: string
  Title: Choice List

  Maximum Length: 2000

  Concatenated list of answer identifiers (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.
• ChoiceShortDescription: string
  Title: Choice Short Description

  Read Only: true

  Concatenated list of answer texts (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Name of the user who created the question response.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the question response was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the question response was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Name of the user who last updated the question response.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuestionAnswerId: integer (int64)
  Title: Question Answer Id

  Surrogate identifier of the answer that a participant chose when responding to a single choice question.
• QuestionCode: string
  Title: Question Code

  Maximum Length: 240

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

  Surrogate identifier for the question.
• QuestionnaireQuestionId: integer (int64)
  Title: Questionnaire Question Id

  Surrogate identifier for the question in a questionnaire.
• questionResponseAttachments: array Question Response Attachments
  Title: Question Response Attachments

  The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.
• QuestionResponseId: integer (int64)
  Title: Question Response Id

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

  Read Only: true

  Maximum Length: 2000

  Text of the question that the participant responds to.
• Score: integer (int64)
  Title: Answer Score

  Read Only: true

  Calculated score for the responses provided for a question by the participant.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who last updated the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the question response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnswerList":{
            "title":"Answer List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers (separated by a delimiter) selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "questionResponseAttachments":{
            "title":"Question Response Attachments",
            "type":"array",
            "description":"The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.",
            "items":{
                "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
            }
        },
        "ChoiceList":{
            "title":"Choice List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.",
            "nullable":true,
            "x-queryable":false
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts (separated by a delimiter) selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices (separated by a delimiter) selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ChoiceShortDescription":{
            "title":"Choice Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCode":{
            "title":"Answer Code",
            "maxLength":240,
            "type":"string",
            "description":"Code of the answer that a participant chose when responding to a single choice question.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "dependencies":[
                    "QuestionnaireQuestionId"
                ]
            },
            "x-queryable":true
        },
        "Score":{
            "title":"Answer Score",
            "type":"integer",
            "description":"Calculated score for the responses provided for a question by the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant to respond to the question.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChoiceCodeList":{
            "title":"Choice List Code",
            "type":"string",
            "description":"Concatenated list of answer codes (separated by a delimiter) that are presented to the participant when responding to a question enabled for random order.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that the participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the question response was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Question Response Attachments

Type: array

Title: Question Response Attachments

The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.

Show Source

• Array of: object questionnaireParticipants-questionnaireResponses-questionResponses-questionResponseAttachments-item-response

{
    "title":"Question Response Attachments",
    "type":"array",
    "description":"The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.",
    "items":{
        "$ref":"#/components/schemas/questionnaireParticipants-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

Nested Schema : questionnaireParticipants-questionnaireResponses-questionResponses-questionResponseAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided exclusively for the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Category name of the attachment. This is a read-only attribute.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the file can be shared. The default value is false and it's the only supported value.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the person who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Attachment type supported for the question. Only the attachment type, FILE, is supported.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Surrogate identifier of the document attached to the questionnaire.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Path of the folder.
• DmVersionNumber: string
  Maximum Length: 255

  Version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Error status code of the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error status message of the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Expiration date of the attachment. This is a read-only attribute.
• FileContents: string (byte)
  Title: File Contents

  File contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  Name of the attachment file.
• FileUrl: string
  Title: File Url

  File URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64 encoded image of the file displayed in .png format when the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the attachment record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  Name of the user who last updated the attachment record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name of the user who last updated the attachment.
• 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

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the uploaded file. This is a read-only attribute.
• UploadedFileLength: integer
  Title: File Size

  Size of the uploaded file. This is a read-only attribute.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the uploaded file. This is a read-only attribute.
• UploadedText: string
  Title: Uploaded Text

  Text uploaded in the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment. This is a read-only attribute.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of a web page type of attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image of the file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"URI of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type of attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached to the questionnaire.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the person who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error status message of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"User name of the person who uploaded the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment type supported for the question. Only the attachment type, FILE, is supported.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Error status code of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path of the folder.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the attachment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided exclusively for the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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"
    }
}

Back to Top