Jump to

• Request
• Response

Get all content attempt details

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts

Request

Path Parameters

• completionDetailsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• learnerLearningRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
• otherSelectedCourseOfferingsUniqID(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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 the learning assignment and activity content attempt details that match the specified primary key criteria.
    Finder Variables
    • attemptId; integer; Unique identifier for the self-paced activity or tutorial content attempt.
  • findByTableOfContent Finds details for the most recent learning activity attempt, or activity content details if there's no attempt on the activity.
    Finder Variables
    • pEffectiveDate; string;
    • pPersonId; integer;
    • pRootLearningItemId; integer;
• 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:
  

  • activityContentAttemptStatus; string; Status for the content attempt. Possible values are Complete, Exempted, Incomplete, and Not Completed.
  • actualEffort; number; Quantity for the learner effort spent in the attempt.
  • actualEffortUnits; string; Unit of measure, such as hours or minutes, for the learner effort spent in the attempt.
  • actualEffortUnitsMeaning; string; Description of the actualEffortUnits attribute value.
  • actualScore; number; Score achieved in the attempt.
  • attemptEndDate; string; Date when the attempt ended.
  • attemptId; integer; Unique identifier for the self-paced learning activity or tutorial content attempt.
  • attemptPosition; string; Learner attempt position in the activity.
  • attemptRelationNumber; string; Friendly number identifying the association between the learning activity attempt and attempt on the self-paced learning activity.
  • attemptStartDate; string; Date when the attempt started.
  • attemptStatus; string; Status for the learning activity content attempt. Valid values are defined in the AttemptStatusLOV list.
  • attemptStatusMeaning; string; Description of the attemptStatus attribute value.
  • attemptedByDisplayName; string; Display name for the person who attempted the self-paced learning activity.
  • attemptedById; integer; Unique identifier for the person who attempted the self-paced learning activity.
  • attemptedByNumber; string; Friendly number identifying the person who attempted the self-paced learning activity.
  • chapterLevel; number; Chapter level of the activity content.
  • chapterPosition; string; Position of the chapter in the activity.
  • contentCatalogLearningItemDataLink; string; Data link to the catalog learning item added to the activity.
  • contentCatalogLearningItemId; integer; Unique identifier for the catalog learning item added to the activity.
  • contentCatalogLearningItemNumber; string; Friendly number identifying the catalog learning item added to the activity. It's a surrogate key that's shown in the user interface.
  • contentCatalogLearningItemSubType; string; Learning item subtype for the catalog learning item added to the activity.
  • contentCatalogLearningItemType; string; Learning item type for the catalog learning item added to the activity.
  • contentCoverArtLink; string; URL to open the eLearning content cover art directly from the browser.
  • contentId; integer; Unique identifier for the eLearning content.
  • contentLongDescription; string; Long description of the learning activity content.
  • contentNumber; string; Friendly number identifying the learning activity content.
  • contentShortDescription; string; Short description of the activity content.
  • contentTitle; string; Name of the activity content.
  • contentType; string; Type of content, such as SCORM, HACP, VIDEO, or Tutorial. Valid values are defined in the ContentTypeLOV list.
  • contentTypeMeaning; string; Description of the contentType attribute value.
  • contentURL; string; URL to open the eLearning content directly from the browser.
  • disableReview; string; Disable reviews on the attempt.
  • effortUnits; string; Unit of measure for the expected effort.
  • elearnQuestionnaireId; integer; Unique identifier for the questionnaire that's the self-paced assessment learning activity.
  • elearnRichMediaLink; string; URL to open the video directly from the browser.
  • elearnRichMediaSrcLink; string; Source URL for the eLearning activity.
  • expectedEffort; string; Learner effort required to complete the activity content.
  • hideActualScore; string; Hide score on the attempt.
  • passingScore; number; Score required to pass the activity content.
• 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

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-item-response

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

Type: object

Show Source

• activityContentAttemptStatus: string
  Title: Content Attempt Status

  Read Only: true

  Maximum Length: 120

  Status for the content attempt. Possible values are Complete, Exempted, Incomplete, and Not Completed.
• actualEffort: number
  Title: Actual Effort

  Quantity for the learner effort spent in the attempt.
• actualEffortUnits: string
  Title: Actual Effort Units

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_DUR_HOUR

  Unit of measure, such as hours or minutes, for the learner effort spent in the attempt.
• actualEffortUnitsMeaning: string
  Title: Actual Effort Units Description

  Read Only: true

  Maximum Length: 4000

  Description of the actualEffortUnits attribute value.
• actualScore: number
  Title: Score

  Read Only: true

  Score achieved in the attempt.
• attemptedByDisplayName: string
  Title: Attempted By

  Read Only: true

  Display name for the person who attempted the self-paced learning activity.
• attemptedById: integer (int64)
  Title: Attempted by Person ID

  Read Only: true

  Unique identifier for the person who attempted the self-paced learning activity.
• attemptedByNumber: string
  Title: Attempted by Person Number

  Read Only: true

  Friendly number identifying the person who attempted the self-paced learning activity.
• attemptEndDate: string (date-time)
  Title: Last Attempt

  Read Only: true

  Date when the attempt ended.
• attemptId: integer (int64)
  Title: Attempt ID

  Read Only: true

  Unique identifier for the self-paced learning activity or tutorial content attempt.
• attemptPosition: string
  Title: Attempt Position

  Read Only: true

  Learner attempt position in the activity.
• attemptRelationNumber: string
  Title: Attempt Relation Number

  Read Only: true

  Maximum Length: 30

  Friendly number identifying the association between the learning activity attempt and attempt on the self-paced learning activity.
• attemptStartDate: string (date-time)
  Title: Attempt Start Date

  Read Only: true

  Date when the attempt started.
• attemptStatus: string
  Title: Last Attempt Status

  Read Only: true

  Maximum Length: 120

  Status for the learning activity content attempt. Valid values are defined in the AttemptStatusLOV list.
• attemptStatusMeaning: string
  Title: Last Attempt Status Description

  Read Only: true

  Maximum Length: 4000

  Description of the attemptStatus attribute value.
• chapterLevel: number
  Title: Chapter Level

  Read Only: true

  Chapter level of the activity content.
• chapterPosition: string
  Title: Chapter Position

  Read Only: true

  Maximum Length: 19

  Position of the chapter in the activity.
• contentCatalogLearningItemDataLink: string
  Title: Content Catalog Learning Item Data Link

  Maximum Length: 4000

  Data link to the catalog learning item added to the activity.
• contentCatalogLearningItemId: integer
  Title: Content Catalog Learning Item ID

  Read Only: true

  Unique identifier for the catalog learning item added to the activity.
• contentCatalogLearningItemNumber: string
  Title: Content Catalog Learning Item Number

  Maximum Length: 250

  Friendly number identifying the catalog learning item added to the activity. It's a surrogate key that's shown in the user interface.
• contentCatalogLearningItemSubType: string
  Title: Content Catalog Learning Item Subtype

  Read Only: true

  Maximum Length: 32

  Learning item subtype for the catalog learning item added to the activity.
• contentCatalogLearningItemType: string
  Title: Content Catalog Learning Item Type

  Read Only: true

  Maximum Length: 32

  Learning item type for the catalog learning item added to the activity.
• contentCoverArtLink: string
  Title: Content Cover Art Link

  Read Only: true

  Maximum Length: 4000

  URL to open the eLearning content cover art directly from the browser.
• contentId: integer (int64)
  Title: Content ID

  Read Only: true

  Unique identifier for the eLearning content.
• contentLongDescription: string (byte)
  Title: Content Long Description

  Read Only: true

  Long description of the learning activity content.
• contentNumber: string
  Title: Content Number

  Read Only: true

  Maximum Length: 30

  Friendly number identifying the learning activity content.
• contentShortDescription: string
  Title: Content Short Description

  Read Only: true

  Maximum Length: 4000

  Short description of the activity content.
• contentTitle: string
  Title: Content Title

  Read Only: true

  Maximum Length: 250

  Name of the activity content.
• contentType: string
  Title: Content Type

  Read Only: true

  Maximum Length: 32

  Type of content, such as SCORM, HACP, VIDEO, or Tutorial. Valid values are defined in the ContentTypeLOV list.
• contentTypeMeaning: string
  Title: Content Type Description

  Read Only: true

  Maximum Length: 4000

  Description of the contentType attribute value.
• contentURL: string
  Title: Content URL

  Maximum Length: 4000

  URL to open the eLearning content directly from the browser.
• disableReview: string
  Title: Disable Viewing Completed Assessments

  Read Only: true

  Maximum Length: 1

  Disable reviews on the attempt.
• effortUnits: string
  Title: Effort Units

  Read Only: true

  Maximum Length: 30

  Unit of measure for the expected effort.
• elearnQuestionnaireId: integer
  Unique identifier for the questionnaire that's the self-paced assessment learning activity.
• elearnRichMediaLink: string
  Read Only: true

  Maximum Length: 4000

  URL to open the video directly from the browser.
• elearnRichMediaSrcLink: string
  Title: eLearning Rich Media Source Link

  Read Only: true

  Maximum Length: 4000

  Source URL for the eLearning activity.
• expectedEffort: string
  Title: Expected Effort

  Read Only: true

  Maximum Length: 40

  Learner effort required to complete the activity content.
• hideActualScore: string
  Title: Hide Actual Score

  Read Only: true

  Maximum Length: 1

  Hide score on the attempt.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• passingScore: number
  Title: Passing Score

  Read Only: true

  Score required to pass the activity content.
• questionnaireResponses: array Questionnaire Responses
  Title: Questionnaire Responses

  The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

{
    "type":"object",
    "properties":{
        "activityContentAttemptStatus":{
            "title":"Content Attempt Status",
            "maxLength":120,
            "type":"string",
            "description":"Status for the content attempt. Possible values are Complete, Exempted, Incomplete, and Not Completed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Attempt Status"
                }
            },
            "x-queryable":true
        },
        "actualEffort":{
            "title":"Actual Effort",
            "type":"number",
            "description":"Quantity for the learner effort spent in the attempt.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Actual Effort"
                }
            },
            "x-queryable":true
        },
        "actualEffortUnits":{
            "title":"Actual Effort Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure, such as hours or minutes, for the learner effort spent in the attempt.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_DUR_HOUR",
            "x-hints":{
                "help":{
                    "instruction":"Actual Effort Units"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "actualEffortUnitsMeaning":{
            "title":"Actual Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the actualEffortUnits attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Actual Effort Units Description"
                }
            },
            "x-queryable":true
        },
        "actualScore":{
            "title":"Score",
            "type":"number",
            "description":"Score achieved in the attempt.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Score"
                }
            },
            "x-queryable":true
        },
        "attemptEndDate":{
            "title":"Last Attempt",
            "type":"string",
            "description":"Date when the attempt ended.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Last Attempt"
                }
            },
            "x-queryable":true
        },
        "attemptId":{
            "title":"Attempt ID",
            "type":"integer",
            "description":"Unique identifier for the self-paced learning activity or tutorial content attempt.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempt ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "attemptPosition":{
            "title":"Attempt Position",
            "type":"string",
            "description":"Learner attempt position in the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempt Position"
                }
            },
            "x-queryable":true
        },
        "attemptRelationNumber":{
            "title":"Attempt Relation Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the association between the learning activity attempt and attempt on the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempt Relation Number"
                }
            },
            "x-queryable":true
        },
        "attemptStartDate":{
            "title":"Attempt Start Date",
            "type":"string",
            "description":"Date when the attempt started.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempt Start Date"
                }
            },
            "x-queryable":true
        },
        "attemptStatus":{
            "title":"Last Attempt Status",
            "maxLength":120,
            "type":"string",
            "description":"Status for the learning activity content attempt. Valid values are defined in the AttemptStatusLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Last Attempt Status"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "attemptStatusMeaning":{
            "title":"Last Attempt Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the attemptStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Last Attempt Status Description"
                }
            },
            "x-queryable":true
        },
        "attemptedByDisplayName":{
            "title":"Attempted By",
            "type":"string",
            "description":"Display name for the person who attempted the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempted By"
                }
            },
            "x-queryable":true
        },
        "attemptedById":{
            "title":"Attempted by Person ID",
            "type":"integer",
            "description":"Unique identifier for the person who attempted the self-paced learning activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempted by Person ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "attemptedByNumber":{
            "title":"Attempted by Person Number",
            "type":"string",
            "description":"Friendly number identifying the person who attempted the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Attempted by Person Number"
                }
            },
            "x-queryable":true
        },
        "chapterLevel":{
            "title":"Chapter Level",
            "type":"number",
            "description":"Chapter level of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Chapter Level"
                }
            },
            "x-queryable":true
        },
        "chapterPosition":{
            "title":"Chapter Position",
            "maxLength":19,
            "type":"string",
            "description":"Position of the chapter in the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Chapter Position"
                }
            },
            "x-queryable":true
        },
        "contentCatalogLearningItemDataLink":{
            "title":"Content Catalog Learning Item Data Link",
            "maxLength":4000,
            "type":"string",
            "description":"Data link to the catalog learning item added to the activity.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Catalog Learning Item Data Link"
                }
            },
            "x-queryable":true
        },
        "contentCatalogLearningItemId":{
            "title":"Content Catalog Learning Item ID",
            "type":"integer",
            "description":"Unique identifier for the catalog learning item added to the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Catalog Learning Item ID"
                }
            },
            "x-queryable":true
        },
        "contentCatalogLearningItemNumber":{
            "title":"Content Catalog Learning Item Number",
            "maxLength":250,
            "type":"string",
            "description":"Friendly number identifying the catalog learning item added to the activity. It's a surrogate key that's shown in the user interface.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Catalog Learning Item Number"
                }
            },
            "x-queryable":true
        },
        "contentCatalogLearningItemSubType":{
            "title":"Content Catalog Learning Item Subtype",
            "maxLength":32,
            "type":"string",
            "description":"Learning item subtype for the catalog learning item added to the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Catalog Learning Item Subtype"
                }
            },
            "x-queryable":true
        },
        "contentCatalogLearningItemType":{
            "title":"Content Catalog Learning Item Type",
            "maxLength":32,
            "type":"string",
            "description":"Learning item type for the catalog learning item added to the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Catalog Learning Item Type"
                }
            },
            "x-queryable":true
        },
        "contentCoverArtLink":{
            "title":"Content Cover Art Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the eLearning content cover art directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Cover Art Link"
                }
            },
            "x-queryable":true
        },
        "contentId":{
            "title":"Content ID",
            "type":"integer",
            "description":"Unique identifier for the eLearning content.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content ID"
                },
                "precision":18
            },
            "x-queryable":true
        },
        "contentLongDescription":{
            "title":"Content Long Description",
            "type":"string",
            "description":"Long description of the learning activity content.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Long Description"
                }
            },
            "x-queryable":true
        },
        "contentNumber":{
            "title":"Content Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Number"
                }
            },
            "x-queryable":true
        },
        "contentShortDescription":{
            "title":"Content Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"Short description of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Short Description"
                }
            },
            "x-queryable":true
        },
        "contentTitle":{
            "title":"Content Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Title"
                }
            },
            "x-queryable":true
        },
        "contentType":{
            "title":"Content Type",
            "maxLength":32,
            "type":"string",
            "description":"Type of content, such as SCORM, HACP, VIDEO, or Tutorial. Valid values are defined in the ContentTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Type"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "contentTypeMeaning":{
            "title":"Content Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the contentType attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Content Type Description"
                }
            },
            "x-queryable":true
        },
        "contentURL":{
            "title":"Content URL",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the eLearning content directly from the browser.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Content URL"
                }
            },
            "x-queryable":true
        },
        "disableReview":{
            "title":"Disable Viewing Completed Assessments",
            "maxLength":1,
            "type":"string",
            "description":"Disable reviews on the attempt.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Disable Viewing Completed Assessments"
                }
            },
            "x-queryable":true
        },
        "effortUnits":{
            "title":"Effort Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the expected effort.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Effort Units"
                }
            },
            "x-queryable":true
        },
        "elearnQuestionnaireId":{
            "type":"integer",
            "description":"Unique identifier for the questionnaire that's the self-paced assessment learning activity.",
            "nullable":true,
            "x-queryable":true
        },
        "elearnRichMediaLink":{
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the video directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnRichMediaSrcLink":{
            "title":"eLearning Rich Media Source Link",
            "maxLength":4000,
            "type":"string",
            "description":"Source URL for the eLearning activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"eLearning Rich Media Source Link"
                }
            },
            "x-queryable":true
        },
        "expectedEffort":{
            "title":"Expected Effort",
            "maxLength":40,
            "type":"string",
            "description":"Learner effort required to complete the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Expected Effort"
                }
            },
            "x-queryable":true
        },
        "hideActualScore":{
            "title":"Hide Actual Score",
            "maxLength":1,
            "type":"string",
            "description":"Hide score on the attempt.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Hide Actual Score"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "passingScore":{
            "title":"Passing Score",
            "type":"number",
            "description":"Score required to pass the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "help":{
                    "instruction":"Passing Score"
                }
            },
            "x-queryable":true
        },
        "questionnaireResponses":{
            "title":"Questionnaire Responses",
            "type":"array",
            "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-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 : Questionnaire Responses

Type: array

Title: Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-item-response

{
    "title":"Questionnaire Responses",
    "type":"array",
    "description":"The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-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 : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-item-response

Type: object

Show Source

• AttemptNumber: integer (int64)
  Title: Attempt Number

  Read Only: true

  The attempt number of a participant when responding to a questionnaire.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Date on which the questionnaire response was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the questionnaire response.
• LatestAttemptFlag: boolean
  Title: Latest Attempt

  Read Only: true

  Maximum Length: 30

  Default Value: false

  Indicates if the response is the latest 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.
• QuestionnaireParticipantId: integer (int64)
  Title: Questionnaire Participant Id

  Surrogate identifier for the questionnaire participant.
• 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 is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
• Status: string
  Title: Response Status Code

  Maximum Length: 30

  Status of the questionnaire response. I denotes the response is in progress and not 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 a participant for a questionnaire.

{
    "type":"object",
    "properties":{
        "AttemptNumber":{
            "title":"Attempt Number",
            "type":"integer",
            "description":"The attempt number of a participant when 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":"User who created the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date on which the questionnaire response was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestAttemptFlag":{
            "title":"Latest Attempt",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates if the response is the latest 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
            }
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "Status":{
            "title":"Response Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Response Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "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
            }
        },
        "TotalScore":{
            "title":"Total Score",
            "type":"number",
            "description":"Total score for the responses submitted by a participant for a questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "scale":2
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-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 : Question Responses

Type: array

Title: Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response

Type: object

Show Source

• AnswerCode: string
  Title: Answer Code

  Read Only: true

  Maximum Length: 240

  The answer code 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 semicolon as a delimiter, which is 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 when responding to a question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is 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 semicolon as a delimiter, which is 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 semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceList: string
  Title: Choice List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceShortDescription: string
  Title: Choice Short Description

  Read Only: true

  Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Date on which the question response was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  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 is a child of the questionResponses resource. It includes attachments added in response 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 a participant responds to.
• Score: integer (int64)
  Title: Answer Score

  Read Only: true

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

{
    "type":"object",
    "properties":{
        "AnswerCode":{
            "title":"Answer Code",
            "maxLength":240,
            "type":"string",
            "description":"The answer code that a participant chose when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "QuestionnaireQuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "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
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AnswerList":{
            "title":"Answer List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "ChoiceCodeList":{
            "title":"Choice List Code",
            "type":"string",
            "description":"Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":true
        },
        "ChoiceList":{
            "title":"Choice List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChoiceShortDescription":{
            "title":"Choice Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the question response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the question response was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the question response.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        },
        "Score":{
            "title":"Answer Score",
            "type":"integer",
            "description":"Calculated score for the responses provided for a question by a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionResponseAttachments":{
            "title":"Question Response Attachments",
            "type":"array",
            "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-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 : Question Response Attachments

Type: array

Title: Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response

{
    "title":"Question Response Attachments",
    "type":"array",
    "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

Nested Schema : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-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 user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which 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 containing 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

  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

  Date on which the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the attachment 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.
• QuestionResponses: array Question Responses
  Title: Question Responses

  The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
• 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 attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the attachment was created.",
            "format":"date-time",
            "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the attachment 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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"
            }
        },
        "QuestionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response"
            },
            "x-cardinality":"1"
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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 attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Question Responses

Type: array

Title: Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response

{
    "title":"Question Responses",
    "type":"array",
    "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response

Type: object

Show Source

• AnswerCode: string
  Title: Answer Code

  Read Only: true

  Maximum Length: 240

  The answer code 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 semicolon as a delimiter, which is 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 when responding to a question.
• AnswerList: string
  Title: Answer List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is 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 semicolon as a delimiter, which is 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 semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceList: string
  Title: Choice List

  Maximum Length: 2000

  Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• ChoiceShortDescription: string
  Title: Choice Short Description

  Read Only: true

  Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Date on which the question response was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  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 is a child of the questionResponses resource. It includes attachments added in response 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 a participant responds to.
• Score: integer (int64)
  Title: Answer Score

  Read Only: true

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

{
    "type":"object",
    "properties":{
        "AnswerCode":{
            "title":"Answer Code",
            "maxLength":240,
            "type":"string",
            "description":"The answer code that a participant chose when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "QuestionnaireQuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "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
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AnswerList":{
            "title":"Answer List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "ChoiceCodeList":{
            "title":"Choice List Code",
            "type":"string",
            "description":"Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":true
        },
        "ChoiceList":{
            "title":"Choice List",
            "maxLength":2000,
            "type":"string",
            "description":"Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "x-queryable":false
        },
        "ChoiceShortDescription":{
            "title":"Choice Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the question response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the question response was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the question response.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        },
        "Score":{
            "title":"Answer Score",
            "type":"integer",
            "description":"Calculated score for the responses provided for a question by a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "questionResponseAttachments":{
            "title":"Question Response Attachments",
            "type":"array",
            "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-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 : Question Response Attachments

Type: array

Title: Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Show Source

• Array of: object learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response

{
    "title":"Question Response Attachments",
    "type":"array",
    "description":"The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response"
    }
}

Nested Schema : learnerLearningRecords-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-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 user who created the attachment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which 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 containing 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

  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

  Date on which the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the attachment.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  Name of the user who last updated the attachment 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

  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 attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  User name of the person who uploaded the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the user who created the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the attachment was created.",
            "format":"date-time",
            "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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"File contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "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
        },
        "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"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date on which the attachment 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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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 attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top