REST API for Oracle Fusion Cloud HCM

Get all completion details

get

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails

Request

Path Parameters

learnerLearningRecordsUniqID(required): string

This is the hash key of the attributes which make up the composite key for the (learnerLearningRecords) resource and used to uniquely identify an instance of (learnerLearningRecords). The client should not generate the hash key value. Instead, the client should query on the (learnerLearningRecords) collection resource in order to navigate to a specific instance of (learnerLearningRecords) to get the hash key.
primarySelectedCourseOfferingUniqID(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 the completion details for learning assignments that match the specified primary key criteria.
  Finder Variables
  - activityId; integer; Unique identifier for the learning activity.
- findByActivityAssignmentRecordIdAndActivityId Finds the completion details for learning assignments that match the specified assignment criteria.
  Finder Variables
  - activityAssignmentRecordId; integer; Unique identifier for the assignment record.
  - activityId; integer; Unique identifier for the learning activity.
  - dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
- findByActivityId Finds the completion details for the given learning activity identifier.
  Finder Variables
  - activityId; integer; Unique identifier for the learning activity.
- findByCompletionDetailsFilters Finds the completion details of a learning assignment that match the specified criteria.
  Finder Variables
  - activityAttemptStatus; string; Status for the assigned learning activity. Valid values are ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, ORA_ASSN_TASK_IN_PROGRESS and are defined in the list ActivityAttemptStatusLOV.
  - activityExpectedEffort; string; Expected effort for the learning activity.
  - activitySectionNumber; string; Number identifying the learning activity section.
  - activityTitle; string; Title of the activity.
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:
- activityAssignmentRecordId; integer; Activity assignment record ID for the activity attempt.
- activityAttemptAEUnits; string; Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list.
- activityAttemptAEUnitsMeaning; string; Description of the activityAttemptAEUnitsMeaning attribute value.
- activityAttemptActualEffort; number; Actual learner effort to complete the activity.
- activityAttemptActualScore; number; Actual learner score for the activity attempt.
- activityAttemptAssignedToDisplayName; string; Display name of the learning activity attempt assignee.
- activityAttemptAssignedToId; integer; Friendly number identifying the learning activity attempt assignee.
- activityAttemptAssignedToNumber; string; Friendly number identifying the learning activity attempt assignee.
- activityAttemptAssignedToType; string; Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.
- activityAttemptAssignedToTypeMeaning; string; Description of the activity attempt assigned to type.
- activityAttemptComplDate; string; Completion date of the activity attempt.
- activityAttemptDeepLink; string; Deep link URL for the activity when opened in a browser. It opens the learning item activity player.
- activityAttemptEmbedLink; string; Deep link URL to embed the learning activity page in other pages.
- activityAttemptExemptedDate; string; Attempt exemption date for the learning activity attempt.
- activityAttemptExemptedRC; string; Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list.
- activityAttemptExemptedRCMeaning; string; Description of the activityAttemptExemptedRCMeaning attribute value.
- activityAttemptId; number; Application-generated primary key.
- activityAttemptLocked; string; Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N.
- activityAttemptNextAction; string; Next activity action when the learner is working on the activity.
- activityAttemptNumber; string; Number of attempts for the self-paced learning activity.
- activityAttemptStartedDate; string; Date when the learner attempted the activity.
- activityAttemptStatus; string; Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV.
- activityAttemptStatusMeaning; string; Description of the activityAttemptStatusMeaning attribute value.
- activityComplRequirement; string; Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list.
- activityComplRequirementMeaning; string; Description of the activityComplRequirementMeaning attribute value.
- activityContentDisplayMode; string; Determines how learners see the content, such as embedded.
- activityCoverArtLink; string; URL to open the cover art directly from the browser.
- activityDate; string; Date when the ILT activity is worked on. Doesn't apply to any other types of activities.
- activityDescription; string; Description of the learning activity.
- activityDisplayOrder; number; Display order for the learning activities.
- activityEffortUnits; string; Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list.
- activityEffortUnitsMeaning; string; Description of the learning activity effort units.
- activityEndTime; string; ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities.
- activityExpectedEffort; string; Expected effort for the learning activity.
- activityId; integer; Application-generated primary key of the learning activity.
- activityLearnerMarkCompl; string; Indicates whether the learner can mark the activity as completed.
- activityNumber; string; Friendly number identifying the learning activity in the user interface.
- activityPassingScore; number; Passing score for the learning activity.
- activitySecComplRequired; number; Completion requirement for the learning activity section.
- activitySectionAttemptCompletionProgress; number; Number of learning activities completed in a section.
- activitySectionAttemptLocked; string; Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N.
- activitySectionAttemptStatus; string; Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list.
- activitySectionAttemptStatusMeaning; string; Description of the activitySectionAttemptStatus attribute value.
- activitySectionDescription; string; Description of the learning activity section.
- activitySectionDisplayOrder; number; Display order for the learning activity section.
- activitySectionId; number; Application-generated primary key column.
- activitySectionLongDescription; string; Long description of the learning activity.
- activitySectionNumber; string; Number identifying the learning activity section.
- activitySectionTitle; string; Name of the learning activity section.
- activitySectionTotalActivities; number; Total number of learning activities in the section.
- activityShortDescription; string; Description of the learning content activity.
- activityStartTime; string; ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities.
- activityTimeZone; string; ILT activity time zone. Doesn't apply to any other types of activities.
- activityTitle; string; Title of the learning activity.
- activityTotalAttempts; number; Total learner attempts on the activity.
- activityType; string; Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list.
- activityTypeMeaning; string; Description of the learning activity type.
- addToCalendarLink; string; Link to download the .ics file to add the ILT activity to the calendar. Doesn't apply to any other types of activities.
- allowFwdScrub; string; Indicates if forward scrubbing is enabled.Valid values are Y or N.
- completionItemId; integer; Application-generated primary key of the completion item.
- completionItemNumber; string; Friendly number identifying for identifying the completion item.
- dataSecurityPrivilege; string; Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
- dataSecurityPrivilegeMeaning; string; Description of the value of the dataSecurityPrivilege attribute.
- eLearnMarkCompletionOnOpen; string; Set the eLearning to complete when it's opened.
- elearnAttemptReview; string; Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list.
- elearnAttemptReviewMeaning; string; Description of the elearnAttemptReview attribute value.
- elearnAttemptsAllowed; number; Maximum number of attempts allowed on the self-paced learning assessment activity.
- elearnCoverArtLink; string; URL to open the eLearning cover art directly from the browser.
- elearnDisableContentReview; string; Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP.
- elearnDisableReview; string; Disable reviews for the self-paced learning activity.
- elearnDisableReviewForPassedAttempts; string; Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y.
- elearnHideActualScore; string; Hide score for the self-paced learning activity.
- elearnId; number; Application-generated primary key for the eLearning content of the self-paced activity.
- elearnNumber; string; Number for identifying the content that backs the self-paced learning activity.
- elearnQuestionnaireId; integer; Unique identifier for the questionnaire that's the self-paced learning assessment activity.
- elearnQuestionnaireNumber; string; Question number of a question in the eLearning.
- elearnRecordedAttemptsRule; string; Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list.
- elearnRecordedAttemptsRuleMeaning; string; Description of the elearnRecordedAttemptsRule attribute value.
- elearnRichMediaLink; string; URL to open the video directly from the browser.
- elearnRichMediaSrcLink; string; Link to the rich media source file.
- elearnShortDescription; string; Description of the learning content for the self-paced activity.
- elearnShowResponseFeedback; string; Show response feedback for the self-paced learning activity.
- elearnTimePERAttempt; number; Time limit per attempt on the self-paced learning assessment activity.
- elearnTimePERAttemptUnits; string; Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list.
- elearnTimePERAttemptUnitsMeaning; string; Description of the elearnTimePERAttemptUnitsMeaning attribute value.
- elearnTitle; string; Name of the learning content for the self-paced activity.
- elearnType; string; Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list.
- elearnTypeMeaning; string; Description of the elearnTypeMeaning attribute value.
- parentLearningItemSubType; string; Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
- parentLearningItemSubTypeMeaning; string; Description of the attribute learningItemSubType attribute value.
- sectionAttemptComplDate; string; Date when the learner successfully completed the learning activity section.
- virtualClassroomInformation; string; Additional information about the virtual classroom, if used in the learning activity.
- virtualClassroomJoinLink; string; Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.
- virtualClassroomType; string; Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list.
- virtualClassroomTypeMeaning; string; Description of the virtual classroom type.
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:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-item-response

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

Type: object

Show Source

activityAssignmentRecordId: integer (int64)

Title: Activity Assignment Record ID

Read Only: true

Activity assignment record ID for the activity attempt.
activityAttemptActualEffort: number

Title: Actual Effort

Read Only: true

Actual learner effort to complete the activity.
activityAttemptActualScore: number

Title: Activity Attempt Actual Score

Read Only: true

Actual learner score for the activity attempt.
activityAttemptAEUnits: string

Title: Actual Effort Units

Read Only: true

Maximum Length: 120

Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list.
activityAttemptAEUnitsMeaning: string

Title: Actual Effort Units Description

Read Only: true

Maximum Length: 4000

Description of the activityAttemptAEUnitsMeaning attribute value.
activityAttemptAssignedToDisplayName: string

Title: Activity Attempt Assignee

Read Only: true

Maximum Length: 30

Display name of the learning activity attempt assignee.
activityAttemptAssignedToId: integer (int64)

Title: Activity Attempt Assignee Person ID

Read Only: true

Friendly number identifying the learning activity attempt assignee.
activityAttemptAssignedToNumber: string

Title: Activity Attempt Assignee Person Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity attempt assignee.
activityAttemptAssignedToType: string

Title: Activity Attempt Assignee Type

Read Only: true

Maximum Length: 30

Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.
activityAttemptAssignedToTypeMeaning: string

Title: Activity Attempt Assignee Type Description

Read Only: true

Description of the activity attempt assigned to type.
activityAttemptComplDate: string (date-time)

Title: Activity Attempt Completed Date

Read Only: true

Completion date of the activity attempt.
activityAttemptDeepLink: string

Title: Activity Attempt Deep Link

Read Only: true

Maximum Length: 4000

Deep link URL for the activity when opened in a browser. It opens the learning item activity player.
activityAttemptEmbedLink: string

Title: Activity Attempt Embed Link

Read Only: true

Maximum Length: 4000

Deep link URL to embed the learning activity page in other pages.
activityAttemptExemptedDate: string (date-time)

Title: Activity Attempt Exempted Date

Read Only: true

Attempt exemption date for the learning activity attempt.
activityAttemptExemptedRC: string

Title: Activity Attempt Exempted Reason Code

Read Only: true

Maximum Length: 30

Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list.
activityAttemptExemptedRCMeaning: string

Title: Activity Attempt Exempted Reason Code Description

Read Only: true

Maximum Length: 4000

Description of the activityAttemptExemptedRCMeaning attribute value.
activityAttemptId: number

Title: Activity Attempt ID

Read Only: true

Application-generated primary key.
activityAttemptLocked: string

Title: Activity Attempt Locked

Read Only: true

Maximum Length: 1

Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N.
activityAttemptNextAction: string

Title: Activity Attempt Next Action

Read Only: true

Maximum Length: 19

Next activity action when the learner is working on the activity.
activityAttemptNumber: string

Title: Activity Attempt Number

Read Only: true

Maximum Length: 30

Number of attempts for the self-paced learning activity.
activityAttemptStartedDate: string (date-time)

Title: Activity Attempt Started Date

Read Only: true

Date when the learner attempted the activity.
activityAttemptStatus: string

Title: Activity Attempt Status

Maximum Length: 32

Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV.
activityAttemptStatusMeaning: string

Title: Activity Attempt Status Description

Read Only: true

Maximum Length: 4000

Description of the activityAttemptStatusMeaning attribute value.
activityCompletionPredecessorHint: array Activity Completion Predecessor Hints

Title: Activity Completion Predecessor Hints

The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
activityComplRequirement: string

Title: Activity Completion Requirement

Read Only: true

Maximum Length: 120

Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list.
activityComplRequirementMeaning: string

Title: Activity Completion Requirement Description

Read Only: true

Maximum Length: 4000

Description of the activityComplRequirementMeaning attribute value.
activityContentAttempts: array Activity Content Attempts

Title: Activity Content Attempts

The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
activityContentDisplayMode: string

Read Only: true

Maximum Length: 30

Determines how learners see the content, such as embedded.
activityCoverArtLink: string

Title: Activity Cover Art Link

Read Only: true

Maximum Length: 4000

URL to open the cover art directly from the browser.
activityDate: string (date)

Title: Activity Date

Read Only: true

Date when the ILT activity is worked on. Doesn't apply to any other types of activities.
activityDescription: string

Title: Activity Description

Read Only: true

Maximum Length: 4000

Description of the learning activity.
activityDescriptionLong: string (byte)

Read Only: true

Long description of the learning activity.
activityDisplayOrder: number

Title: Activity Position

Read Only: true

Display order for the learning activities.
activityEffortUnits: string

Title: Activity Effort Units

Read Only: true

Maximum Length: 120

Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list.
activityEffortUnitsMeaning: string

Title: Activity Effort Units Description

Read Only: true

Maximum Length: 4000

Description of the learning activity effort units.
activityEndDatetimeUTC: string (date-time)

Title: Activity End Date

Read Only: true

Learning activity end time expressed in UTC format.
activityEndTime: string

Title: Activity End Time

Read Only: true

Maximum Length: 32

ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities.
activityExpectedEffort: string

Title: Expected Effort

Read Only: true

Maximum Length: 83

Expected effort for the learning activity.
activityId: integer (int64)

Title: Activity ID

Read Only: true

Application-generated primary key of the learning activity.
activityLearnerMarkCompl: string

Title: Learner Can Mark Activity Complete

Read Only: true

Maximum Length: 1

Indicates whether the learner can mark the activity as completed.
activityNumber: string

Title: Activity Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity in the user interface.
activityPassingScore: number

Title: Passing Score

Read Only: true

Passing score for the learning activity.
activitySecComplRequired: number

Title: Activity Section Required Activities

Read Only: true

Completion requirement for the learning activity section.
activitySectionAttemptCompletionProgress: number

Title: Activity Section Attempt Completion Progress

Read Only: true

Number of learning activities completed in a section.
activitySectionAttemptLocked: string

Title: Activity Section Attempt Locked

Read Only: true

Maximum Length: 1

Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N.
activitySectionAttemptStatus: string

Title: Activity Section Attempt Status

Read Only: true

Maximum Length: 32

Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list.
activitySectionAttemptStatusMeaning: string

Title: Activity Section Attempt Status Description

Read Only: true

Maximum Length: 4000

Description of the activitySectionAttemptStatus attribute value.
activitySectionCompletionPredecessorHint: array Activity Section Completion Predecessor Hints

Title: Activity Section Completion Predecessor Hints

The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
activitySectionDescription: string

Title: Activity Section Description

Read Only: true

Maximum Length: 4000

Description of the learning activity section.
activitySectionDisplayOrder: number

Title: Activity Section Position

Read Only: true

Display order for the learning activity section.
activitySectionId: number

Title: Activity Section ID

Read Only: true

Application-generated primary key column.
activitySectionLongDescription: string (byte)

Title: Long Description

Read Only: true

Long description of the learning activity.
activitySectionNumber: string

Title: Activity Section Number

Read Only: true

Maximum Length: 30

Number identifying the learning activity section.
activitySectionTitle: string

Title: Activity Section Title

Read Only: true

Maximum Length: 250

Name of the learning activity section.
activitySectionTotalActivities: number

Title: Activity Section Total Activities

Read Only: true

Total number of learning activities in the section.
activityShortDescription: string

Title: Activity Short Description

Read Only: true

Maximum Length: 4000

Description of the learning content activity.
activityStartDatetimeUTC: string (date-time)

Title: Activity Start Date

Read Only: true

Learning activity start time expressed in UTC format.
activityStartTime: string

Title: Activity Start Time

Read Only: true

Maximum Length: 32

ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities.
activityTimeZone: string

Title: Activity Time Zone

Read Only: true

Maximum Length: 30

ILT activity time zone. Doesn't apply to any other types of activities.
activityTitle: string

Title: Activity Title

Read Only: true

Maximum Length: 250

Title of the learning activity.
activityTotalAttempts: number

Title: Activity Total Attempts

Read Only: true

Total learner attempts on the activity.
activityType: string

Title: Activity Type

Read Only: true

Maximum Length: 32

Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list.
activityTypeMeaning: string

Title: Activity Type Description

Read Only: true

Maximum Length: 4000

Description of the learning activity type.
addToCalendarLink: string

Title: Add to Calendar Link

Read Only: true

Maximum Length: 4000

Link to download the .ics file to add the ILT activity to the calendar. Doesn't apply to any other types of activities.
allowFwdScrub: string

Title: Allow learners to fast forward

Read Only: true

Maximum Length: 30

Indicates if forward scrubbing is enabled.Valid values are Y or N.
classrooms: array Classrooms

Title: Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
completionItemId: integer (int64)

Read Only: true

Application-generated primary key of the completion item.
completionItemNumber: string

Read Only: true

Maximum Length: 30

Friendly number identifying for identifying the completion item.
dataSecurityPrivilege: string

Title: Data Security Privilege

Read Only: true

Maximum Length: 32

Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
dataSecurityPrivilegeMeaning: string

Title: Data Security Privilege Description

Read Only: true

Maximum Length: 4000

Description of the value of the dataSecurityPrivilege attribute.
elearnAttemptReview: string

Title: eLearning Attempt Review

Read Only: true

Maximum Length: 120

Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list.
elearnAttemptReviewMeaning: string

Title: eLearning Attempt Review Description

Read Only: true

Maximum Length: 4000

Description of the elearnAttemptReview attribute value.
elearnAttemptsAllowed: number

Title: eLearning Attempts Allowed

Read Only: true

Maximum number of attempts allowed on the self-paced learning assessment activity.
elearnCoverArtLink: string

Title: eLearning Cover Art Link

Read Only: true

Maximum Length: 4000

URL to open the eLearning cover art directly from the browser.
elearnDisableContentReview: string

Title: eLearning Disable Content Review

Read Only: true

Maximum Length: 1

Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP.
elearnDisableReview: string

Title: eLearning Disable Review

Read Only: true

Maximum Length: 1

Disable reviews for the self-paced learning activity.
elearnDisableReviewForPassedAttempts: string

Title: eLearning Disable Review for Passed Attempts

Read Only: true

Maximum Length: 1

Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y.
elearnHideActualScore: string

Title: eLearning Hide Actual Score

Read Only: true

Maximum Length: 1

Hide score for the self-paced learning activity.
elearnId: number

Title: eLearning ID

Read Only: true

Application-generated primary key for the eLearning content of the self-paced activity.
eLearnMarkCompletionOnOpen: string

Title: eLearning Mark Completion on Open

Read Only: true

Maximum Length: 1

Set the eLearning to complete when it's opened.
elearnNumber: string

Title: eLearning Number

Read Only: true

Maximum Length: 30

Number for identifying the content that backs the self-paced learning activity.
elearnQuestionnaireId: integer (int64)

Title: Questionnaire ID

Read Only: true

Unique identifier for the questionnaire that's the self-paced learning assessment activity.
elearnQuestionnaireNumber: string

Title: Questionnaire Number

Read Only: true

Maximum Length: 19

Question number of a question in the eLearning.
elearnRecordedAttemptsRule: string

Title: eLearning Recorded Attempts Rule

Read Only: true

Maximum Length: 120

Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list.
elearnRecordedAttemptsRuleMeaning: string

Title: eLearning Recorded Attempts Rule Description

Read Only: true

Maximum Length: 4000

Description of the elearnRecordedAttemptsRule attribute value.
elearnRichMediaLink: string

Title: eLearning Rich Media Link

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

Link to the rich media source file.
elearnShortDescription: string

Title: eLearning Description

Read Only: true

Maximum Length: 4000

Description of the learning content for the self-paced activity.
elearnShowResponseFeedback: string

Title: eLearning Show Response Feedback

Read Only: true

Maximum Length: 1

Show response feedback for the self-paced learning activity.
elearnTimePERAttempt: number

Title: eLearning Time per Attempt

Read Only: true

Time limit per attempt on the self-paced learning assessment activity.
elearnTimePERAttemptUnits: string

Title: eLearning Time per Attempt Units

Read Only: true

Maximum Length: 30

Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list.
elearnTimePERAttemptUnitsMeaning: string

Title: eLearning Time per Attempt Units Description

Read Only: true

Maximum Length: 4000

Description of the elearnTimePERAttemptUnitsMeaning attribute value.
elearnTitle: string

Title: eLearning Title

Read Only: true

Maximum Length: 250

Name of the learning content for the self-paced activity.
elearnType: string

Title: eLearning Type

Read Only: true

Maximum Length: 80

Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list.
elearnTypeMeaning: string

Title: eLearning Type Description

Read Only: true

Maximum Length: 4000

Description of the elearnTypeMeaning attribute value.
instructors: array Instructors

Title: Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
links: array Links

Title: Links

The link relations associated with the resource instance.
offeredLanguages: array Offered Languages

Title: Offered Languages

The offeredLanguages resource provides the offering language for a learning item.
offeredLocations: array Offered Locations

Title: Offered Locations

The offeredLocations resource provides the location details for a learning item.
parentLearningItemSubType: string

Title: Parent Assigned Learning Item Subtype

Read Only: true

Maximum Length: 32

Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
parentLearningItemSubTypeMeaning: string

Title: Parent Assigned Learning Item Subtype Description

Read Only: true

Maximum Length: 4000

Description of the attribute learningItemSubType attribute value.
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.
relatedMaterials: array Related Materials

Title: Related Materials

The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
sectionAttemptComplDate: string (date-time)

Title: Activity Section Completion Date

Read Only: true

Date when the learner successfully completed the learning activity section.
virtualClassroomInformation: string

Title: Virtual Classroom Information

Read Only: true

Maximum Length: 19

Additional information about the virtual classroom, if used in the learning activity.
virtualClassroomJoinLink: string

Title: Virtual Classroom Join Link

Read Only: true

Maximum Length: 4000

Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.
virtualClassroomType: string

Title: Virtual Classroom Type

Read Only: true

Maximum Length: 40

Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list.
virtualClassroomTypeMeaning: string

Title: Virtual Classroom Type Description

Read Only: true

Description of the virtual classroom type.

{
    "type":"object",
    "properties":{
        "activityAttemptNextAction":{
            "title":"Activity Attempt Next Action",
            "maxLength":19,
            "type":"string",
            "description":"Next activity action when the learner is working on the activity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "offeringLearningItemId"
                ]
            },
            "x-queryable":true
        },
        "activityCoverArtLink":{
            "title":"Activity Cover Art Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the cover art directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityShortDescription":{
            "title":"Activity Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning content activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptExemptedRCMeaning":{
            "title":"Activity Attempt Exempted Reason Code Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activityAttemptExemptedRCMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityEffortUnits":{
            "title":"Activity Effort Units",
            "maxLength":120,
            "type":"string",
            "description":"Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "elearnQuestionnaireNumber":{
            "title":"Questionnaire Number",
            "maxLength":19,
            "type":"string",
            "description":"Question number of a question in the eLearning.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "elearnQuestionnaireId"
                ]
            },
            "x-queryable":true
        },
        "activityAttemptAssignedToType":{
            "title":"Activity Attempt Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "elearnHideActualScore":{
            "title":"eLearning Hide Actual Score",
            "maxLength":1,
            "type":"string",
            "description":"Hide score for the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionItemId":{
            "type":"integer",
            "description":"Application-generated primary key of the completion item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "elearnTitle":{
            "title":"eLearning Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the learning content for the self-paced activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityContentAttempts":{
            "title":"Activity Content Attempts",
            "type":"array",
            "description":"The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-response"
            }
        },
        "elearnShowResponseFeedback":{
            "title":"eLearning Show Response Feedback",
            "maxLength":1,
            "type":"string",
            "description":"Show response feedback for the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTimePERAttemptUnitsMeaning":{
            "title":"eLearning Time per Attempt Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the elearnTimePERAttemptUnitsMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "addToCalendarLink":{
            "title":"Add to Calendar Link",
            "maxLength":4000,
            "type":"string",
            "description":"Link to download the .ics file to add the ILT activity to the calendar. Doesn't apply to any other types of activities.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "activityLearningItemId"
                ]
            },
            "x-queryable":true
        },
        "eLearnMarkCompletionOnOpen":{
            "title":"eLearning Mark Completion on Open",
            "maxLength":1,
            "type":"string",
            "description":"Set the eLearning to complete when it's opened.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityExpectedEffort":{
            "title":"Expected Effort",
            "maxLength":83,
            "type":"string",
            "description":"Expected effort for the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "allowFwdScrub":{
            "title":"Allow learners to fast forward",
            "maxLength":30,
            "type":"string",
            "description":"Indicates if forward scrubbing is enabled.Valid values are Y or N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptDeepLink":{
            "title":"Activity Attempt Deep Link",
            "maxLength":4000,
            "type":"string",
            "description":"Deep link URL for the activity when opened in a browser. It opens the learning item activity player.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "offeringLearningItemId"
                ]
            },
            "x-queryable":true
        },
        "activityTitle":{
            "title":"Activity Title",
            "maxLength":250,
            "type":"string",
            "description":"Title of the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptStartedDate":{
            "title":"Activity Attempt Started Date",
            "type":"string",
            "description":"Date when the learner attempted the activity.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptLocked":{
            "title":"Activity Attempt Locked",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionNumber":{
            "title":"Activity Section Number",
            "maxLength":30,
            "type":"string",
            "description":"Number identifying the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "parentLearningItemSubTypeMeaning":{
            "title":"Parent Assigned Learning Item Subtype Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the attribute learningItemSubType attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnAttemptsAllowed":{
            "title":"eLearning Attempts Allowed",
            "type":"number",
            "description":"Maximum number of attempts allowed on the self-paced learning assessment activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "completionItemNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying for identifying the completion item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptComplDate":{
            "title":"Activity Attempt Completed Date",
            "type":"string",
            "description":"Completion date of the activity attempt.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptAssignedToId":{
            "title":"Activity Attempt Assignee Person ID",
            "type":"integer",
            "description":"Friendly number identifying the learning activity attempt assignee.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "activityAttemptExemptedRC":{
            "title":"Activity Attempt Exempted Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-item-response"
            }
        },
        "activityTypeMeaning":{
            "title":"Activity Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning activity type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityStartDatetimeUTC":{
            "title":"Activity Start Date",
            "type":"string",
            "description":"Learning activity start time expressed in UTC format.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "classrooms":{
            "title":"Classrooms",
            "type":"array",
            "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-response"
            }
        },
        "activitySectionCompletionPredecessorHint":{
            "title":"Activity Section Completion Predecessor Hints",
            "type":"array",
            "description":"The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-response"
            },
            "x-cardinality":"1"
        },
        "elearnNumber":{
            "title":"eLearning Number",
            "maxLength":30,
            "type":"string",
            "description":"Number for identifying the content that backs the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptStatus":{
            "title":"Activity Section Attempt Status",
            "maxLength":32,
            "type":"string",
            "description":"Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityDescriptionLong":{
            "type":"string",
            "description":"Long description of the learning activity.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "elearnQuestionnaireId":{
            "title":"Questionnaire ID",
            "type":"integer",
            "description":"Unique identifier for the questionnaire that's the self-paced learning assessment activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":19
            },
            "x-queryable":true
        },
        "elearnShortDescription":{
            "title":"eLearning Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning content for the self-paced activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sectionAttemptComplDate":{
            "title":"Activity Section Completion Date",
            "type":"string",
            "description":"Date when the learner successfully completed the learning activity section.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityStartTime":{
            "title":"Activity Start Time",
            "maxLength":32,
            "type":"string",
            "description":"ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActivityStartDatetime"
                ]
            },
            "x-queryable":true
        },
        "activityAttemptAEUnitsMeaning":{
            "title":"Actual Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activityAttemptAEUnitsMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptAEUnits":{
            "title":"Actual Effort Units",
            "maxLength":120,
            "type":"string",
            "description":"Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activitySectionId":{
            "title":"Activity Section ID",
            "type":"number",
            "description":"Application-generated primary key column.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityDate":{
            "title":"Activity Date",
            "type":"string",
            "description":"Date when the ILT activity is worked on. Doesn't apply to any other types of activities.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActivityStartDatetime"
                ]
            },
            "x-queryable":true
        },
        "virtualClassroomTypeMeaning":{
            "title":"Virtual Classroom Type Description",
            "type":"string",
            "description":"Description of the virtual classroom type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptEmbedLink":{
            "title":"Activity Attempt Embed Link",
            "maxLength":4000,
            "type":"string",
            "description":"Deep link URL to embed the learning activity page in other pages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityTotalAttempts":{
            "title":"Activity Total Attempts",
            "type":"number",
            "description":"Total learner attempts on the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptActualEffort":{
            "title":"Actual Effort",
            "type":"number",
            "description":"Actual learner effort to complete the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTypeMeaning":{
            "title":"eLearning Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the elearnTypeMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityEndDatetimeUTC":{
            "title":"Activity End Date",
            "type":"string",
            "description":"Learning activity end time expressed in UTC format.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "activityEffortUnitsMeaning":{
            "title":"Activity Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning activity effort units.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnAttemptReviewMeaning":{
            "title":"eLearning Attempt Review Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the elearnAttemptReview attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "relatedMaterials":{
            "title":"Related Materials",
            "type":"array",
            "description":"The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-response"
            }
        },
        "elearnType":{
            "title":"eLearning Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activitySectionDescription":{
            "title":"Activity Section Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptLocked":{
            "title":"Activity Section Attempt Locked",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptId":{
            "title":"Activity Attempt ID",
            "type":"number",
            "description":"Application-generated primary key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnRichMediaSrcLink":{
            "title":"eLearning Rich Media Source Link",
            "maxLength":4000,
            "type":"string",
            "description":"Link to the rich media source file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "offeredLocations":{
            "title":"Offered Locations",
            "type":"array",
            "description":"The offeredLocations resource provides the location details for a learning item.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-response"
            }
        },
        "elearnRecordedAttemptsRule":{
            "title":"eLearning Recorded Attempts Rule",
            "maxLength":120,
            "type":"string",
            "description":"Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "virtualClassroomInformation":{
            "title":"Virtual Classroom Information",
            "maxLength":19,
            "type":"string",
            "description":"Additional information about the virtual classroom, if used in the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityDisplayOrder":{
            "title":"Activity Position",
            "type":"number",
            "description":"Display order for the learning activities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "instructors":{
            "title":"Instructors",
            "type":"array",
            "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-response"
            }
        },
        "activityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Application-generated primary key of the learning activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "dataSecurityPrivilege":{
            "title":"Data Security Privilege",
            "maxLength":32,
            "type":"string",
            "description":"Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "activityContentDisplayMode":{
            "maxLength":30,
            "type":"string",
            "description":"Determines how learners see the content, such as embedded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "dataSecurityPrivilegeMeaning":{
            "title":"Data Security Privilege Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the dataSecurityPrivilege attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnCoverArtLink":{
            "title":"eLearning Cover Art Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the eLearning cover art directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionDisplayOrder":{
            "title":"Activity Section Position",
            "type":"number",
            "description":"Display order for the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnDisableReview":{
            "title":"eLearning Disable Review",
            "maxLength":1,
            "type":"string",
            "description":"Disable reviews for the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnId":{
            "title":"eLearning ID",
            "type":"number",
            "description":"Application-generated primary key for the eLearning content of the self-paced activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnDisableReviewForPassedAttempts":{
            "title":"eLearning Disable Review for Passed Attempts",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTimePERAttemptUnits":{
            "title":"eLearning Time per Attempt Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityAttemptNumber":{
            "title":"Activity Attempt Number",
            "maxLength":30,
            "type":"string",
            "description":"Number of attempts for the self-paced learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "parentLearningItemSubType":{
            "title":"Parent Assigned Learning Item Subtype",
            "maxLength":32,
            "type":"string",
            "description":"Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "elearnRecordedAttemptsRuleMeaning":{
            "title":"eLearning Recorded Attempts Rule Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the elearnRecordedAttemptsRule attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityEndTime":{
            "title":"Activity End Time",
            "maxLength":32,
            "type":"string",
            "description":"ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActivityEndDatetime"
                ]
            },
            "x-queryable":true
        },
        "activitySectionTitle":{
            "title":"Activity Section Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityDescription":{
            "title":"Activity Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityNumber":{
            "title":"Activity Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity in the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnTimePERAttempt":{
            "title":"eLearning Time per Attempt",
            "type":"number",
            "description":"Time limit per attempt on the self-paced learning assessment activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityCompletionPredecessorHint":{
            "title":"Activity Completion Predecessor Hints",
            "type":"array",
            "description":"The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response"
            },
            "x-cardinality":"1"
        },
        "activitySectionAttemptCompletionProgress":{
            "title":"Activity Section Attempt Completion Progress",
            "type":"number",
            "description":"Number of learning activities completed in a section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptStatusMeaning":{
            "title":"Activity Attempt Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activityAttemptStatusMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityComplRequirementMeaning":{
            "title":"Activity Completion Requirement Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activityComplRequirementMeaning attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityPassingScore":{
            "title":"Passing Score",
            "type":"number",
            "description":"Passing score for the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityLearnerMarkCompl":{
            "title":"Learner Can Mark Activity Complete",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learner can mark the activity as completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "virtualClassroomJoinLink":{
            "title":"Virtual Classroom Join Link",
            "maxLength":4000,
            "type":"string",
            "description":"Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptAssignedToDisplayName":{
            "title":"Activity Attempt Assignee",
            "maxLength":30,
            "type":"string",
            "description":"Display name of the learning activity attempt assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionTotalActivities":{
            "title":"Activity Section Total Activities",
            "type":"number",
            "description":"Total number of learning activities in the section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptStatus":{
            "title":"Activity Attempt Status",
            "maxLength":32,
            "type":"string",
            "description":"Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "offeredLanguages":{
            "title":"Offered Languages",
            "type":"array",
            "description":"The offeredLanguages resource provides the offering language for a learning item.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response"
            }
        },
        "elearnDisableContentReview":{
            "title":"eLearning Disable Content Review",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptStatusMeaning":{
            "title":"Activity Section Attempt Status Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activitySectionAttemptStatus attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnAttemptReview":{
            "title":"eLearning Attempt Review",
            "maxLength":120,
            "type":"string",
            "description":"Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activitySecComplRequired":{
            "title":"Activity Section Required Activities",
            "type":"number",
            "description":"Completion requirement for the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionLongDescription":{
            "title":"Long Description",
            "type":"string",
            "description":"Long description of the learning activity.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptAssignedToTypeMeaning":{
            "title":"Activity Attempt Assignee Type Description",
            "type":"string",
            "description":"Description of the activity attempt assigned to type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityComplRequirement":{
            "title":"Activity Completion Requirement",
            "maxLength":120,
            "type":"string",
            "description":"Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityAttemptAssignedToNumber":{
            "title":"Activity Attempt Assignee Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity attempt assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptExemptedDate":{
            "title":"Activity Attempt Exempted Date",
            "type":"string",
            "description":"Attempt exemption date for the learning activity attempt.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptActualScore":{
            "title":"Activity Attempt Actual Score",
            "type":"number",
            "description":"Actual learner score for the activity attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "elearnRichMediaLink":{
            "title":"eLearning Rich Media Link",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the video directly from the browser.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAssignmentRecordId":{
            "title":"Activity Assignment Record ID",
            "type":"integer",
            "description":"Activity assignment record ID for the activity attempt.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "virtualClassroomType":{
            "title":"Virtual Classroom Type",
            "maxLength":40,
            "type":"string",
            "description":"Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityType":{
            "title":"Activity Type",
            "maxLength":32,
            "type":"string",
            "description":"Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityTimeZone":{
            "title":"Activity Time Zone",
            "maxLength":30,
            "type":"string",
            "description":"ILT activity time zone. Doesn't apply to any other types of activities.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Activity Completion Predecessor Hints

Type: array

Title: Activity Completion Predecessor Hints

The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response

{
    "title":"Activity Completion Predecessor Hints",
    "type":"array",
    "description":"The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Activity Content Attempts

Type: array

Title: Activity Content Attempts

The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-response

{
    "title":"Activity Content Attempts",
    "type":"array",
    "description":"The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-response"
    }
}

Nested Schema : Activity Section Completion Predecessor Hints

Type: array

Title: Activity Section Completion Predecessor Hints

The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-response

{
    "title":"Activity Section Completion Predecessor Hints",
    "type":"array",
    "description":"The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Classrooms

Type: array

Title: Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-response

{
    "title":"Classrooms",
    "type":"array",
    "description":"The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-response"
    }
}

Nested Schema : Instructors

Type: array

Title: Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-response

{
    "title":"Instructors",
    "type":"array",
    "description":"The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-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 : Offered Languages

Type: array

Title: Offered Languages

The offeredLanguages resource provides the offering language for a learning item.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response

{
    "title":"Offered Languages",
    "type":"array",
    "description":"The offeredLanguages resource provides the offering language for a learning item.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response"
    }
}

Nested Schema : Offered Locations

Type: array

Title: Offered Locations

The offeredLocations resource provides the location details for a learning item.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-response

{
    "title":"Offered Locations",
    "type":"array",
    "description":"The offeredLocations resource provides the location details for a learning item.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-response"
    }
}

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-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-item-response"
    }
}

Nested Schema : Related Materials

Type: array

Title: Related Materials

The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-response

{
    "title":"Related Materials",
    "type":"array",
    "description":"The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-response"
    }
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response

Type: object

Show Source

activityAttemptAssignedToType: string

Title: Activity Predecessor Attempt Assignee Type

Read Only: true

Maximum Length: 30

Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.
activityAttemptAssignedToTypeMeaning: string

Title: Activity Predecessor Attempt Assignee Type Description

Read Only: true

Description of the type of user assigned to the learning activity attempt.
activityAttemptLocked: string

Title: Activity Predecessor Attempt Locked

Read Only: true

Maximum Length: 1

Indicates whether the learner can attempt the activity. Valid values are Y and N. Default value is N.
activityAttemptNumber: string

Title: Activity Predecessor Attempt Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity attempt.
activityAttemptStatus: string

Title: Activity Predecessor Attempt Status

Read Only: true

Maximum Length: 32

Status for the learning activity attempt. Valid values are Y and N. Default value is N. Valid values are defined in the learning activityAttemptStatusLOV list.
activityNumber: string

Title: Activity Predecessor Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity.
activityTitle: string

Title: Activity Predecessor Title

Read Only: true

Maximum Length: 255

Title of the activity.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "activityAttemptStatus":{
            "title":"Activity Predecessor Attempt Status",
            "maxLength":32,
            "type":"string",
            "description":"Status for the learning activity attempt. Valid values are Y and N. Default value is N. Valid values are defined in the learning activityAttemptStatusLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityAttemptLocked":{
            "title":"Activity Predecessor Attempt Locked",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learner can attempt the activity. Valid values are Y and N. Default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityAttemptAssignedToTypeMeaning":{
            "title":"Activity Predecessor Attempt Assignee Type Description",
            "type":"string",
            "description":"Description of the type of user assigned to the learning activity attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityTitle":{
            "title":"Activity Predecessor Title",
            "maxLength":255,
            "type":"string",
            "description":"Title of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "activityAttemptAssignedToType":{
            "title":"Activity Predecessor Attempt Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activityAttemptNumber":{
            "title":"Activity Predecessor Attempt Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activityNumber":{
            "title":"Activity Predecessor Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : 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-primarySelectedCourseOffering-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.
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":{
        "actualEffortUnitsMeaning":{
            "title":"Actual Effort Units Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the actualEffortUnits attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "chapterPosition":{
            "title":"Chapter Position",
            "maxLength":19,
            "type":"string",
            "description":"Position of the chapter in the activity.",
            "nullable":true,
            "readOnly":true,
            "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-queryable":true
        },
        "contentId":{
            "title":"Content ID",
            "type":"integer",
            "description":"Unique identifier for the eLearning content.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "contentTypeMeaning":{
            "title":"Content Type Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the contentType attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "passingScore":{
            "title":"Passing Score",
            "type":"number",
            "description":"Score required to pass the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "hideActualScore":{
            "title":"Hide Actual Score",
            "maxLength":1,
            "type":"string",
            "description":"Hide score on the attempt.",
            "nullable":true,
            "readOnly":true,
            "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-queryable":true
        },
        "contentShortDescription":{
            "title":"Content Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"Short description of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "chapterLevel":{
            "title":"Chapter Level",
            "type":"number",
            "description":"Chapter level of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "actualEffort":{
            "title":"Actual Effort",
            "type":"number",
            "description":"Quantity for the learner effort spent in the attempt.",
            "nullable":true,
            "x-queryable":true
        },
        "attemptEndDate":{
            "title":"Last Attempt",
            "type":"string",
            "description":"Date when the attempt ended.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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-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-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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-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-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":{
                "controlType":"choice"
            },
            "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-queryable":true
        },
        "effortUnits":{
            "title":"Effort Units",
            "maxLength":30,
            "type":"string",
            "description":"Unit of measure for the expected effort.",
            "nullable":true,
            "readOnly":true,
            "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-queryable":true
        },
        "attemptPosition":{
            "title":"Attempt Position",
            "type":"string",
            "description":"Learner attempt position in the activity.",
            "nullable":true,
            "readOnly":true,
            "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":{
                "precision":18
            },
            "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-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-queryable":true
        },
        "actualScore":{
            "title":"Score",
            "type":"number",
            "description":"Score achieved in the attempt.",
            "nullable":true,
            "readOnly":true,
            "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-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-queryable":true
        },
        "contentTitle":{
            "title":"Content Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the activity content.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contentNumber":{
            "title":"Content Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity content.",
            "nullable":true,
            "readOnly":true,
            "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":{
                "precision":18
            },
            "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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-item-response"
            }
        },
        "contentURL":{
            "title":"Content URL",
            "maxLength":4000,
            "type":"string",
            "description":"URL to open the eLearning content directly from the browser.",
            "nullable":true,
            "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":{
                "controlType":"choice"
            },
            "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-queryable":true
        },
        "disableReview":{
            "title":"Disable Viewing Completed Assessments",
            "maxLength":1,
            "type":"string",
            "description":"Disable reviews on the attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attemptStartDate":{
            "title":"Attempt Start Date",
            "type":"string",
            "description":"Date when the attempt started.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "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-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":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : Questionnaire Responses

Type: array

Title: Questionnaire Responses

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

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-item-response"
    }
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Response Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
            }
        },
        "SubmittedDateTime":{
            "title":"Submitted Time",
            "type":"string",
            "description":"Date on which the questionnaire response was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionnaireResponseId":{
            "title":"Questionnaire Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "StatusMeaning":{
            "title":"Response Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalScore":{
            "title":"Total Score",
            "type":"number",
            "description":"Total score for the responses submitted by a participant for a questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "scale":2
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date on which the questionnaire response was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : Question Responses

Type: array

Title: Question Responses

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

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated 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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
            }
        },
        "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
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        }
    }
}

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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated 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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response"
            }
        },
        "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
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        }
    }
}

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-response

Type: object

Show Source

activitySectionAttemptAssignedToType: string

Title: Activity Section Predecessor Attempt Assignee Type

Read Only: true

Maximum Length: 30

Type of user, such as Learner or Observer, assigned to the activity section attempt. Valid values are defined in the ActivitySectionAttemptAssignedToTypeLOV list.
activitySectionAttemptAssignedToTypeMeaning: string

Title: Activity Section Predecessor Attempt Assignee Type Description

Read Only: true

Description of the type of user assigned to the learning activity section attempt.
activitySectionAttemptLocked: string

Title: Activity Section Predecessor Attempt Locked

Read Only: true

Maximum Length: 1

Indicates whether the learner can attempt the activity section. Valid values are Y and N. Default value is N. Valid values are defined in the ActivitySectionAttemptStatusLOV.
activitySectionAttemptNumber: string

Title: Activity Section Predecessor Attempt Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity section attempt.
activitySectionAttemptStatus: string

Title: Activity Section Predecessor Attempt Status

Read Only: true

Maximum Length: 32

Status for the learning activity section attempt. Valid values are defined in the learning activitySectionAttemptStatusLOV list.
activitySectionNumber: string

Title: Activity Section Predecessor Number

Read Only: true

Maximum Length: 30

Friendly number identifying the learning activity section.
activitySectionTitle: string

Title: Activity Section Predecessor Title

Read Only: true

Maximum Length: 255

Title of the activity section.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "activitySectionNumber":{
            "title":"Activity Section Predecessor Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptAssignedToTypeMeaning":{
            "title":"Activity Section Predecessor Attempt Assignee Type Description",
            "type":"string",
            "description":"Description of the type of user assigned to the learning activity section attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionTitle":{
            "title":"Activity Section Predecessor Title",
            "maxLength":255,
            "type":"string",
            "description":"Title of the activity section.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptStatus":{
            "title":"Activity Section Predecessor Attempt Status",
            "maxLength":32,
            "type":"string",
            "description":"Status for the learning activity section attempt. Valid values are defined in the learning activitySectionAttemptStatusLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "activitySectionAttemptLocked":{
            "title":"Activity Section Predecessor Attempt Locked",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the learner can attempt the activity section. Valid values are Y and N. Default value is N. Valid values are defined in the ActivitySectionAttemptStatusLOV.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "activitySectionAttemptNumber":{
            "title":"Activity Section Predecessor Attempt Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the learning activity section attempt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "activitySectionAttemptAssignedToType":{
            "title":"Activity Section Predecessor Attempt Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of user, such as Learner or Observer, assigned to the activity section attempt. Valid values are defined in the ActivitySectionAttemptAssignedToTypeLOV list.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-response

Type: object

Show Source

attachments: array Attachments

Title: Attachments

The attachments resource is used to view, create, and update attachments.
classroomDescription: string

Title: Classroom Description

Read Only: true

Maximum Length: 4000

Description of the classroom.
classroomDFFs: array classroomDFFs
classroomId: integer (int64)

Title: Classroom ID

Read Only: true

System-generated primary key for a classroom.
classroomNumber: string

Title: Classroom Number

Read Only: true

Maximum Length: 30

Friendly number for identifying a classroom.
classroomTitle: string

Title: Classroom Title

Read Only: true

Maximum Length: 250

Name of the classroom.
contactPersonDisplayName: string

Title: Contact Person Display Name

Read Only: true

Maximum Length: 240

Display name for the person who's the classroom contact.
contactPersonId: integer (int64)

Title: Contact Person ID

Read Only: true

Identifier for the person who's the classroom contact.
contactPersonImageURL: string

Title: Contact Person Image URL

Read Only: true

Maximum Length: 32

Image URL for the person who's the classroom contact.
contactPersonNumber: string

Title: Contact Person Number

Read Only: true

Maximum Length: 30

Person number for the classroom contact person.
contactPersonPrimaryEmailAddress: string

Title: Contact Person Primary Email Address

Read Only: true

Maximum Length: 60

Primary email address of the person who's the classroom contact.
contactPersonPrimaryPhoneNumber: string

Title: Contact Person Primary Phone Number

Read Only: true

Maximum Length: 240

Primary phone number for the person who's the classroom contact.
isPrimaryClassroom: string

Title: Primary Classroom

Read Only: true

Maximum Length: 1

Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N.
isPrimaryClassroomMeaning: string

Title: Primary Classroom Description

Read Only: true

Maximum Length: 4000

Description of the value of the isPrimaryClassroom attribute.
links: array Links

Title: Links

The link relations associated with the resource instance.
locationAddressLine1: string

Title: Location Address Line 1

Read Only: true

Maximum Length: 240

Location address line 1.
locationAddressLine2: string

Title: Location Address Line 2

Read Only: true

Maximum Length: 240

Location address line 2.
locationAddressLine3: string

Title: Location Address Line 3

Read Only: true

Maximum Length: 240

Location address line 3.
locationCity: string

Title: Location City

Read Only: true

Maximum Length: 60

City of the classroom.
locationCountry: string

Title: Location Country

Read Only: true

Maximum Length: 60

Country of the classroom.
locationDisplayString: string

Title: Location Display String

Read Only: true

Maximum Length: 32

Complete classroom address in the string format.
locationLatitude: number

Title: Location Latitude

Read Only: true

Latitude of the classroom.
locationLongitude: number

Title: Location Longitude

Read Only: true

Longitude of the classroom.
locationName: string

Title: Location Name

Read Only: true

Maximum Length: 240

Location of the classroom.
locationSingleLineString: string

Read Only: true

Maximum Length: 1732

Location of the classroom expressed as a single line string.
locationZipCode: string

Title: Location ZIP Code

Read Only: true

Maximum Length: 30

Postal code of the location address.

{
    "type":"object",
    "properties":{
        "isPrimaryClassroom":{
            "title":"Primary Classroom",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "contactPersonPrimaryPhoneNumber":{
            "title":"Contact Person Primary Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Primary phone number for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contactPersonImageURL":{
            "title":"Contact Person Image URL",
            "maxLength":32,
            "type":"string",
            "description":"Image URL for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contactPersonPrimaryEmailAddress":{
            "title":"Contact Person Primary Email Address",
            "maxLength":60,
            "type":"string",
            "description":"Primary email address of the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response"
            }
        },
        "locationAddressLine1":{
            "title":"Location Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 1.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationAddressLine2":{
            "title":"Location Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "classroomId":{
            "title":"Classroom ID",
            "type":"integer",
            "description":"System-generated primary key for a classroom.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "classroomTitle":{
            "title":"Classroom Title",
            "maxLength":250,
            "type":"string",
            "description":"Name of the classroom.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "locationCountry":{
            "title":"Location Country",
            "maxLength":60,
            "type":"string",
            "description":"Country of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "isPrimaryClassroomMeaning":{
            "title":"Primary Classroom Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the value of the isPrimaryClassroom attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationSingleLineString":{
            "maxLength":1732,
            "type":"string",
            "description":"Location of the classroom expressed as a single line string.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationLongitude":{
            "title":"Location Longitude",
            "type":"number",
            "description":"Longitude of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "classroomNumber":{
            "title":"Classroom Number",
            "maxLength":30,
            "type":"string",
            "description":"Friendly number for identifying a classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationDisplayString":{
            "title":"Location Display String",
            "maxLength":32,
            "type":"string",
            "description":"Complete classroom address in the string format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationName":{
            "title":"Location Name",
            "maxLength":240,
            "type":"string",
            "description":"Location of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "classroomDFFs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-response"
            }
        },
        "locationLatitude":{
            "title":"Location Latitude",
            "type":"number",
            "description":"Latitude of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "classroomDescription":{
            "title":"Classroom Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationZipCode":{
            "title":"Location ZIP Code",
            "maxLength":30,
            "type":"string",
            "description":"Postal code of the location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contactPersonId":{
            "title":"Contact Person ID",
            "type":"integer",
            "description":"Identifier for the person who's the classroom contact.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "locationAddressLine3":{
            "title":"Location Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"Location address line 3.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contactPersonDisplayName":{
            "title":"Contact Person Display Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name for the person who's the classroom contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "locationCity":{
            "title":"Location City",
            "maxLength":60,
            "type":"string",
            "description":"City of the classroom.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contactPersonNumber":{
            "title":"Contact Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number for the classroom contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response"
    }
}

Nested Schema : classroomDFFs

Type: array

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-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-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response

Type: object

Show Source

AsyncTrackerId: string

Attribute provided by the Attachment UI components to support the upload of files.
AttachedDocumentId: integer (int64)

Unique identifier of the attached document.
attachmentId: integer

Title: Attachment Id

Read Only: true

ID of the attachment.
attachmentLink: string

Title: Attachment Link

Read Only: true

Maximum Length: 4000

Link to the attachment.
attachmentName: string

Title: Attachment Name

Read Only: true

Maximum Length: 4000

Name of the attachment.
attachmentNumber: string

Title: Attachment Number

Read Only: true

Friendly number for identifying the attachment.
attachmentType: string

Title: Attachment Type

Read Only: true

Maximum Length: 4000

Type of the attachment.
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

Read Only: true

Maximum Length: 255

User who created the attachment.
CreatedByUserName: string

Read Only: true

User name of the user who created the attachment.
CreationDate: string (date-time)

Read Only: true

Date when the attachment was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

Attachment Type such as FILE or TEXT, or WEB_PAGE.
Description: string

Title: Description

Maximum Length: 255

Description of the attachment.
DmDocumentId: string

Maximum Length: 255

Surrogate identifier of the document attached.
DmFolderPath: string

Maximum Length: 1000

The folder path from which the attachment is created.
DmVersionNumber: string

Maximum Length: 255

Version number of the attachment.
DownloadInfo: string

Read Only: true

JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

The error status code, if any, for the attachment.
ErrorStatusMessage: string

The error message, if any, for the attachment.
ExpirationDate: string (date-time)

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

Title: File Contents

Actual content of the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

Name of the attachment file.
FileUrl: string

File URL of the attachment.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

Base64 encoded image file displayed in .png format when the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when attachment record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

Name of the user who last updated the attachment record.
LastUpdatedByUserName: string

Read Only: true

User name of the user who last updated the attachment.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be done after an attachment is uploaded.
Title: string

Title: Title

Title of the attachment.
UploadedFileContentType: string

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

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

Text uploaded in the attachment.
Uri: string

Maximum Length: 4000

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

Maximum Length: 4000

URL of a web page type attachment.
UserName: string

Read Only: true

Maximum Length: 255

URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "attachmentNumber":{
            "title":"Attachment Number",
            "type":"string",
            "description":"Friendly number for identifying the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachmentType":{
            "title":"Attachment Type",
            "maxLength":4000,
            "type":"string",
            "description":"Type of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "attachmentLink":{
            "title":"Attachment Link",
            "maxLength":4000,
            "type":"string",
            "description":"Link to the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedByUserName":{
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attachmentId":{
            "title":"Attachment Id",
            "type":"integer",
            "description":"ID of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "attachmentName":{
            "title":"Attachment Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30
__FLEX_Context_DisplayValue: string

Title: Context Segment
links: array Links

Title: Links

The link relations associated with the resource instance.
ResourceId: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-response

Type: object

Show Source

instructorDFF: array instructorDFF
instructorId: integer (int64)

Title: Instructor ID

Read Only: true

Unique identifier for the instructor.
instructorNumber: string

Title: Instructor Number

Read Only: true

Maximum Length: 19

Friendly number for identifying the instructor.
isPrimaryInstructor: string

Title: Primary Instructor

Read Only: true

Maximum Length: 1

Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N.
links: array Links

Title: Links

The link relations associated with the resource instance.
personDisplayName: string

Title: Instructor

Read Only: true

Maximum Length: 240

Display name for the instructor.
personId: integer (int64)

Title: Instructor Person ID

Read Only: true

Identifier for the person who's the instructor.
personImageURL: string

Title: Instructor Image URL

Read Only: true

Maximum Length: 32

Image URL for the instructor for the learning item.
personNumber: string

Title: Instructor Person Number

Read Only: true

Maximum Length: 30

Person number for the instructor.
personPrimaryEmailAddress: string

Title: Instructor Primary Email Address

Read Only: true

Maximum Length: 60

Primary Email address of the instructor for the learning item.
personPrimaryPhoneNumber: string

Title: Instructor Primary Phone Number

Read Only: true

Maximum Length: 240

Phone number of the instructor of the learning item.

{
    "type":"object",
    "properties":{
        "personPrimaryPhoneNumber":{
            "title":"Instructor Primary Phone Number",
            "maxLength":240,
            "type":"string",
            "description":"Phone number of the instructor of the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "instructorDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-response"
            }
        },
        "isPrimaryInstructor":{
            "title":"Primary Instructor",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personDisplayName":{
            "title":"Instructor",
            "maxLength":240,
            "type":"string",
            "description":"Display name for the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personImageURL":{
            "title":"Instructor Image URL",
            "maxLength":32,
            "type":"string",
            "description":"Image URL for the instructor for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "personId"
                ]
            },
            "x-queryable":true
        },
        "personPrimaryEmailAddress":{
            "title":"Instructor Primary Email Address",
            "maxLength":60,
            "type":"string",
            "description":"Primary Email address of the instructor for the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "personId":{
            "title":"Instructor Person ID",
            "type":"integer",
            "description":"Identifier for the person who's the instructor.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "instructorNumber":{
            "title":"Instructor Number",
            "maxLength":19,
            "type":"string",
            "description":"Friendly number for identifying the instructor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personNumber":{
            "title":"Instructor Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Person number for the instructor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "instructorId":{
            "title":"Instructor ID",
            "type":"integer",
            "description":"Unique identifier for the instructor.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : instructorDFF

Type: array

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-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-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30
__FLEX_Context_DisplayValue: string

Title: Context Segment
links: array Links

Title: Links

The link relations associated with the resource instance.
ResourceId: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response

Type: object

Show Source

language: string

Title: Language

Read Only: true

Maximum Length: 255

Language for the selected learning assignment offering.
languageCode: string

Title: Language Code

Read Only: true

Maximum Length: 30

Language code for the selected learning assignment offering.
languageCodeMeaning: string

Title: Language Code Description

Read Only: true

Maximum Length: 4000

Description of the languageCode attribute value.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "language":{
            "title":"Language",
            "maxLength":255,
            "type":"string",
            "description":"Language for the selected learning assignment offering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "languageCode":{
            "title":"Language Code",
            "maxLength":30,
            "type":"string",
            "description":"Language code for the selected learning assignment offering.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "languageCodeMeaning":{
            "title":"Language Code Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the languageCode attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-response

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.
locationCity: string

Title: Location City

Read Only: true

Maximum Length: 60

City where the selected learning assignment offering is delivered.
locationCountry: string

Title: Location Country

Read Only: true

Maximum Length: 60

Country where the selected learning assignment offering is delivered.
locationTitle: string

Title: Location Name

Read Only: true

Maximum Length: 93

City-state-country for the ILT type offering. For other offering types, it's Virtual Classroom or Self Paced, as applicable.

{
    "type":"object",
    "properties":{
        "locationTitle":{
            "title":"Location Name",
            "maxLength":93,
            "type":"string",
            "description":"City-state-country for the ILT type offering. For other offering types, it's Virtual Classroom or Self Paced, as applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "locationCountry":{
            "title":"Location Country",
            "maxLength":60,
            "type":"string",
            "description":"Country where the selected learning assignment offering is delivered.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "locationCity":{
            "title":"Location City",
            "maxLength":60,
            "type":"string",
            "description":"City where the selected learning assignment offering is delivered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the questionnaire response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Response Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the questionnaire response was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
            }
        },
        "SubmittedDateTime":{
            "title":"Submitted Time",
            "type":"string",
            "description":"Date on which the questionnaire response was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "questionResponses":{
            "title":"Question Responses",
            "type":"array",
            "description":"The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-item-response"
            }
        },
        "QuestionnaireVersionNumber":{
            "title":"Questionnaire Version",
            "type":"integer",
            "description":"Version number of the questionnaire that the participant responds to.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            }
        },
        "QuestionnaireResponseId":{
            "title":"Questionnaire Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the questionnaire response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "StatusMeaning":{
            "title":"Response Status",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TotalScore":{
            "title":"Total Score",
            "type":"number",
            "description":"Total score for the responses submitted by a participant for a questionnaire.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "scale":2
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date on which the questionnaire response was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : Question Responses

Type: array

Title: Question Responses

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

Show Source

Array of: object learnerLearningRecords-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-item-response"
    }
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated 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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
            }
        },
        "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
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        }
    }
}

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-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-item-response"
    }
}

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

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-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated 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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the question response.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response"
            }
        },
        "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
        },
        "QuestionResponseId":{
            "title":"Question Response Id",
            "type":"integer",
            "description":"Surrogate identifier for the question response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "AnswerComments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional comments provided by the participant when responding to a question.",
            "nullable":true,
            "x-queryable":true
        },
        "AnswerShortDescriptionList":{
            "title":"Answer Short Description",
            "type":"string",
            "description":"Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AnswerCodeList":{
            "title":"Answer Code List",
            "type":"string",
            "description":"Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.",
            "nullable":true,
            "x-queryable":true
        },
        "QuestionnaireQuestionId":{
            "title":"Questionnaire Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question in a questionnaire.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
            }
        },
        "QuestionCode":{
            "title":"Question Code",
            "maxLength":240,
            "type":"string",
            "description":"Alphanumeric value that uniquely identifies a question defined for a subscriber.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "AnswerShortdescription":{
            "title":"Answer Short Description",
            "maxLength":240,
            "type":"string",
            "description":"Text of the answer chosen by a participant when responding to a single choice question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QuestionId":{
            "title":"Question Id",
            "type":"integer",
            "description":"Surrogate identifier for the question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "QuestionAnswerId":{
            "title":"Question Answer Id",
            "type":"integer",
            "description":"Surrogate identifier of the answer that a participant chose when responding to a single choice question.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "dependencies":[
                    "QuestionCode",
                    "QuestionId"
                ]
            },
            "x-queryable":true
        },
        "AnswerLargeObject":{
            "title":"Answer",
            "type":"string",
            "description":"Attachment provided by the participant when responding to a question.",
            "format":"byte",
            "nullable":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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "QuestionText":{
            "title":"Question Text",
            "maxLength":2000,
            "type":"string",
            "description":"Text of the question that a participant responds to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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
        }
    }
}

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-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response"
    }
}

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-response

Type: object

Show Source

AsyncTrackerId: string

Attribute provided by the Attachment UI components to support the upload of files.
AttachedDocumentId: integer (int64)

Unique identifier of the attached document.
attachmentId: integer

Title: Attachment Id

Read Only: true

ID of the attachment.
attachmentLink: string

Title: Attachment Link

Read Only: true

Maximum Length: 4000

Link to the attachment.
attachmentName: string

Title: Attachment Name

Read Only: true

Maximum Length: 4000

Name of the attachment.
attachmentNumber: string

Title: Attachment Number

Read Only: true

User-friendly number for identifying the attachment.
attachmentType: string

Title: Attachment Type

Read Only: true

Maximum Length: 4000

Type of the attachment.
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

Read Only: true

Maximum Length: 255

User who created the attachment.
CreatedByUserName: string

Read Only: true

User name of the user who created the attachment.
CreationDate: string (date-time)

Read Only: true

Date when the attachment was created.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

Attachment Type such as FILE or TEXT, or WEB_PAGE.
Description: string

Title: Description

Maximum Length: 255

Description of the attachment.
DmDocumentId: string

Maximum Length: 255

Surrogate identifier of the document attached.
DmFolderPath: string

Maximum Length: 1000

The folder path from which the attachment is created.
DmVersionNumber: string

Maximum Length: 255

Version number of the attachment.
DownloadInfo: string

Read Only: true

JSON object represented as a string that contains information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

The error status code, if any, for the attachment.
ErrorStatusMessage: string

The error message, if any, for the attachment.
ExpirationDate: string (date-time)

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

Title: File Contents

Actual content of the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

Name of the attachment file.
FileUrl: string

File URL of the attachment.
FileWebImage: string (byte)

Title: File Web Image

Read Only: true

Base64 encoded image file displayed in .png format when the source is a convertible image.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when attachment record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

Name of the user who last updated the attachment record.
LastUpdatedByUserName: string

Read Only: true

User name of the user who last updated the attachment.
links: array Links

Title: Links

The link relations associated with the resource instance.
PostProcessingAction: string

Title: PostProcessingAction

The name of the action that can be done after an attachment is uploaded.
SourceId: integer (int64)

Read Only: true

Unique identifier for the source where this assignment was created.
Title: string

Title: Title

Title of the attachment.
UploadedFileContentType: string

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

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

Text uploaded in the attachment.
Uri: string

Maximum Length: 4000

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

Maximum Length: 4000

URL of a web page type attachment.
UserName: string

Read Only: true

Maximum Length: 255

URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "attachmentNumber":{
            "title":"Attachment Number",
            "type":"string",
            "description":"User-friendly number for identifying the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "attachmentType":{
            "title":"Attachment Type",
            "maxLength":4000,
            "type":"string",
            "description":"Type of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceId":{
            "type":"integer",
            "description":"Unique identifier for the source where this assignment was created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64 encoded image file displayed in .png format when the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "attachmentLink":{
            "title":"Attachment Link",
            "maxLength":4000,
            "type":"string",
            "description":"Link to the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":{
            "maxLength":4000,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"Surrogate identifier of the document attached.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "type":"integer",
            "description":"Unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"Content type of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "type":"string",
            "description":"JSON object represented as a string that contains information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreatedByUserName":{
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attachmentId":{
            "title":"Attachment Id",
            "type":"integer",
            "description":"ID of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who last updated the attachment record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"URL of a web page type attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Attachment Type such as FILE or TEXT, or WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be done after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"User name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "type":"string",
            "description":"Name of the uploaded file. This is a read-only attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "type":"string",
            "description":"File URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the file can be shared. The default value is false and it's the only supported value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Actual content of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "type":"string",
            "description":"Expiration date of the attachment. This is a read-only attribute.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error status code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "type":"string",
            "description":"Text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Category name of the attachment. This is a read-only attribute.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "attachmentName":{
            "title":"Attachment Name",
            "maxLength":4000,
            "type":"string",
            "description":"Name of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when attachment record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided by the Attachment UI components to support the upload of files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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