> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # blackboard-system > Blackboard System - LTI, proctoring, uploads, system info, and assessments **Server path:** `/blackboard-system` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | | [`blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_delete_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Delete Question | | [`blackboard_system_delete_learn_api_public_lti_domains_by_domainid`](#blackboard_system_delete_learn_api_public_lti_domains_by_domainid) | Delete Domain Config | | [`blackboard_system_delete_learn_api_public_lti_placements_by_placementid`](#blackboard_system_delete_learn_api_public_lti_placements_by_placementid) | Delete Placement | | [`blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions`](#blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions) | Get Questions | | [`blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_get_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Get Question By Id | | [`blackboard_system_get_learn_api_public_lti_domains`](#blackboard_system_get_learn_api_public_lti_domains) | Get Domain Configs | | [`blackboard_system_get_learn_api_public_lti_domains_by_domainid`](#blackboard_system_get_learn_api_public_lti_domains_by_domainid) | Get Domain Config | | [`blackboard_system_get_learn_api_public_lti_placements`](#blackboard_system_get_learn_api_public_lti_placements) | Get Placements | | [`blackboard_system_get_learn_api_public_lti_placements_by_placementid`](#blackboard_system_get_learn_api_public_lti_placements_by_placementid) | Get Placement | | [`blackboard_system_get_learn_api_public_proctoring_services`](#blackboard_system_get_learn_api_public_proctoring_services) | Get Proctoring Services | | [`blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceid`](#blackboard_system_get_learn_api_public_proctoring_services_by_proctoringserviceid) | Get Proctoring Service | | [`blackboard_system_get_learn_api_public_system_policies_privacy`](#blackboard_system_get_learn_api_public_system_policies_privacy) | Get Policies | | [`blackboard_system_get_learn_api_public_system_tasks_by_taskid`](#blackboard_system_get_learn_api_public_system_tasks_by_taskid) | Get System Task | | [`blackboard_system_get_learn_api_public_system_version`](#blackboard_system_get_learn_api_public_system_version) | Get Version | | [`blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid`](#blackboard_system_patch_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions_by_questionid) | Update Question | | [`blackboard_system_patch_learn_api_public_lti_domains_by_domainid`](#blackboard_system_patch_learn_api_public_lti_domains_by_domainid) | Update Domain Config | | [`blackboard_system_patch_learn_api_public_lti_placements_by_placementid`](#blackboard_system_patch_learn_api_public_lti_placements_by_placementid) | Update Placement | | [`blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions`](#blackboard_system_post_learn_api_public_courses_by_courseid_assessments_by_assessmentid_questions) | Create Question | | [`blackboard_system_post_learn_api_public_lti_domains`](#blackboard_system_post_learn_api_public_lti_domains) | Create Domain Config | | [`blackboard_system_post_learn_api_public_lti_placements`](#blackboard_system_post_learn_api_public_lti_placements) | Create Placement | | [`blackboard_system_post_learn_api_public_uploads`](#blackboard_system_post_learn_api_public_uploads) | Upload | *** ## blackboard\_system\_delete\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Delete Question **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_delete\_learn\_api\_public\_lti\_domains\_by\_domainid Delete Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_delete\_learn\_api\_public\_lti\_placements\_by\_placementid Delete Placement **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions Get Questions **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Get Question By Id **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_domains Get Domain Configs **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_domains\_by\_domainid Get Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_placements Get Placements **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `handle` | string | No | — | Search for placements with handle properties that contain this value. **Since**: 3200.12.0 | | `name` | string | No | — | Search for placements with name properties that contain this value. **Since**: 3200.12.0 | | `type` | string | No | — | Search for placements with type properties that contain this value. **Since**: 3200.12.0 \| Type \| Description \| --------- \| --------- \| \| Application \| Application or Student Tool Placement \| \| ContentHandler \| Content Type placement \| \| ContentItemMessage \| Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 \| \| System \| System-level Tools \| \| Administrator \| Administrator-level Tools **Since**: 3400.1.0 \| \| UltraUI \| Ultra-UI Extensions **Since**: 3700.6.0 \| \| BaseNavigation \| Base Navigation \| \| CourseNavigation \| Course Navigation \| \| Proctoring \| Proctoring **Since**: 3900.10.0 \| | | `authorId` | string | No | — | Search for placements with author ID properties that contain this value. **Since**: 3200.12.0 **Deprecated**: since 3900.0.0; Field was never used and has been removed | | `courseId` | string | No | — | Search for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently **Since**: 3900.0.0 | | `sort` | string | No | — | Properties to sort by. This is a comma-delimited list of JSON properties, with an optional "(desc)" suffix to request a descending sort for that property. e.g. "name.family(desc),created" **Since**: 3100.0.0 | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "handle": { "type": "string", "description": "Search for placements with handle properties that contain this value. **Since**: 3200.12.0" }, "name": { "type": "string", "description": "Search for placements with name properties that contain this value. **Since**: 3200.12.0" }, "type": { "type": "string", "description": "Search for placements with type properties that contain this value. **Since**: 3200.12.0 | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools **Since**: 3400.1.0 | | UltraUI | Ultra-UI Extensions **Since**: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring **Since**: 3900.10.0 |", "enum": [ "Application", "ContentHandler", "ContentItemMessage", "System", "Administrator", "UltraUI", "BaseNavigation", "CourseNavigation", "Proctoring" ] }, "authorId": { "type": "string", "description": "Search for placements with author ID properties that contain this value. **Since**: 3200.12.0 **Deprecated**: since 3900.0.0; Field was never used and has been removed" }, "courseId": { "type": "string", "description": "Search for LTI placements that are available for this course. Note this only applies to Application, ContentHandler, and ContentItemMessage types currently **Since**: 3900.0.0" }, "sort": { "type": "string", "description": "Properties to sort by. This is a comma-delimited list of JSON properties, with an optional \"(desc)\" suffix to request a descending sort for that property. e.g. \"name.family(desc),created\" **Since**: 3100.0.0" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_lti\_placements\_by\_placementid Get Placement **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_proctoring\_services Get Proctoring Services **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `offset` | integer | No | — | The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter. | | `limit` | integer | No | — | The maximum number of results to be returned. There may be less if the query returned less than the maximum. | | `availability.available` | string | No | — | Search for proctoring services with availability.available properties that contain this value. \| Type \| Description \| --------- \| --------- \| \| Yes \| \| \| No \| \| | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "offset": { "type": "integer", "description": "The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter." }, "limit": { "type": "integer", "description": "The maximum number of results to be returned. There may be less if the query returned less than the maximum." }, "availability.available": { "type": "string", "description": "Search for proctoring services with availability.available properties that contain this value. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_proctoring\_services\_by\_proctoringserviceid Get Proctoring Service **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `proctoringServiceId` | string | Yes | — | Proctoring Service Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "proctoringServiceId": { "type": "string", "description": "Proctoring Service Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "proctoringServiceId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_policies\_privacy Get Policies **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------------------------------------- | | `locale` | string | No | — | the locale, otherwise it defaults to en\_US | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "locale": { "type": "string", "description": "the locale, otherwise it defaults to en_US" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_tasks\_by\_taskid Get System Task **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `taskId` | string | Yes | — | Task Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "taskId": { "type": "string", "description": "Task Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID", "taskId" ] } ``` *** ## blackboard\_system\_get\_learn\_api\_public\_system\_version Get Version ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions\_by\_questionid Update Question **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `questionId` | string | Yes | — | Question Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `correctResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is correct. | | `incorrectResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is incorrect. | | `instructorNotes` | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. | | `points` | number | No | — | The point value for the question. | | `position` | integer | No | — | Position of the Question on the Assessment Canvas. | | `questionHandler` | object | No | — | Question Handler | | `text` | string | No | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. | | `title` | string | No | — | The title of the question. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "questionId": { "type": "string", "description": "Question Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "correctResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is correct." }, "incorrectResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is incorrect." }, "instructorNotes": { "type": "string", "description": "Text added to the question as a note for the instructor. It is not intended to be displayed to students." }, "points": { "type": "number", "description": "The point value for the question." }, "position": { "type": "integer", "description": "Position of the Question on the Assessment Canvas." }, "questionHandler": { "type": "object", "description": "Question Handler", "properties": { "type": { "type": "string", "description": "Type of Question supported. | Type | Description | --------- | --------- | | Presentation | **Since**: 3300.9.0 | | EitherOr | Read Only **Since**: 3300.9.0 | | Essay | Read Only **Since**: 3300.9.0 | | MultipleAnswer | Read Only **Since**: 3400.4.0 | | Numeric | Read Only **Since**: 3400.4.0 | | MultipleChoice | Read Only **Since**: 3400.4.0 | | Ordering | Read Only **Since**: 3400.4.0 | | Matching | Read Only **Since**: 3400.4.0 | | FillInTheBlank | Read Only **Since**: 3400.4.0 | | Calculated | Read Only **Since**: 3400.4.0 | | FileResponse | Read Only **Since**: 3400.4.0 | | LikertOpinionScale | Read Only **Since**: 3400.4.0 | | QuizBowl | Read Only **Since**: 3400.4.0 | | HotSpot | Read Only **Since**: 3400.4.0 | | JumbledSentence | Read Only **Since**: 3400.4.0 | | FillInTheBlankPlus | Read Only **Since**: 3400.4.0 | | QuestionBlock | Read Only **Since**: 3700.2.0 |", "enum": [ "Presentation", "EitherOr", "Essay", "MultipleAnswer", "Numeric", "MultipleChoice", "Ordering", "Matching", "FillInTheBlank", "Calculated", "FileResponse", "LikertOpinionScale", "QuizBowl", "HotSpot", "JumbledSentence", "FillInTheBlankPlus", "QuestionBlock" ] } } }, "text": { "type": "string", "description": "The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor." }, "title": { "type": "string", "description": "The title of the question." } }, "required": [ "PCID", "courseId", "assessmentId", "questionId" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_lti\_domains\_by\_domainid Update Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `domainId` | string | Yes | — | Domain Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGradesService` | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0 | | `allowMembershipService` | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. | | `clientId` | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0 | | `customParameters` | object | No | — | The custom parameters for the given domain. | | `description` | string | No | — | The description of the domain configuration **Since**: 3900.23.0 | | `jwksUrl` | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `key` | string | No | — | The key value | | `name` | string | No | — | The name of the domain configuration **Since**: 3900.23.0 | | `primaryDomain` | string | No | — | The primary domain name associated with this configuration. | | `publicKey` | string | No | — | The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `secret` | string | No | — | The secret value | | `sendEmail` | boolean | No | — | Whether the user's email address can be sent to the LTI tool provider. | | `sendName` | boolean | No | — | Whether the user's name can be sent to the LTI tool provider. | | `sendRole` | boolean | No | — | Whether the user's role can be sent to the LTI tool provider. | | `sendUserDataType` | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. \| Type \| Description \| --------- \| --------- \| \| Never \| \| \| Sslonly \| \| \| Always \| **Since**: 3300.9.0 \| | | `status` | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. \| Type \| Description \| --------- \| --------- \| \| Approved \| \| \| Excluded \| \| \| NeedsApproval \| **Since**: 3300.9.0 \| | | `useSplashScreen` | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "domainId": { "type": "string", "description": "Domain Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGradesService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0" }, "allowMembershipService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships." }, "clientId": { "type": "string", "description": "The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0" }, "customParameters": { "type": "object", "description": "The custom parameters for the given domain." }, "description": { "type": "string", "description": "The description of the domain configuration **Since**: 3900.23.0" }, "jwksUrl": { "type": "string", "description": "The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "string", "description": "The name of the domain configuration **Since**: 3900.23.0" }, "primaryDomain": { "type": "string", "description": "The primary domain name associated with this configuration." }, "publicKey": { "type": "string", "description": "The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "secret": { "type": "string", "description": "The secret value" }, "sendEmail": { "type": "boolean", "description": "Whether the user's email address can be sent to the LTI tool provider." }, "sendName": { "type": "boolean", "description": "Whether the user's name can be sent to the LTI tool provider." }, "sendRole": { "type": "boolean", "description": "Whether the user's role can be sent to the LTI tool provider." }, "sendUserDataType": { "type": "string", "description": "Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | **Since**: 3300.9.0 |", "enum": [ "Never", "Sslonly", "Always" ] }, "status": { "type": "string", "description": "Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | **Since**: 3300.9.0 |", "enum": [ "Approved", "Excluded", "NeedsApproval" ] }, "useSplashScreen": { "type": "boolean", "description": "Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true." } }, "required": [ "PCID", "domainId" ] } ``` *** ## blackboard\_system\_patch\_learn\_api\_public\_lti\_placements\_by\_placementid Update Placement **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `placementId` | string | Yes | — | Placement Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `allowGrading` | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum\[Type]#`ContentHandler` types. All others don't support grading and will be set to false. | | `allowStudents` | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. | | `authorId` | string | No | — | Id of the creator of the placement **Deprecated**: since 3900.0 not used | | `availability` | object | No | — | Settings controlling availability of the placement. | | `customParameters` | object | No | — | Custom launch parameters for the tool. | | `description` | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD\_REQUEST error with message is returned if greater than 1000 characters. | | `iconUrl` | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD\_REQUEST error with message is returned if greater than 255 characters or incomplete URL. | | `instructorCreated` | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used | | `key` | string | No | — | The key value | | `launchInNewWindow` | boolean | No | — | Whether this placement link should be opened in a new window or not. | | `name` | string | No | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD\_REQUEST error with message is returned if greater than 50 characters. | | `secret` | string | No | — | The secret value | | `url` | string | No | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD\_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "placementId": { "type": "string", "description": "Placement Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "allowGrading": { "type": "boolean", "description": "Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#`ContentHandler` types. All others don't support grading and will be set to false." }, "allowStudents": { "type": "boolean", "description": "Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool." }, "authorId": { "type": "string", "description": "Id of the creator of the placement **Deprecated**: since 3900.0 not used" }, "availability": { "type": "object", "description": "Settings controlling availability of the placement.", "properties": { "available": { "type": "string", "description": "Whether the placement is available within the system. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] } } }, "customParameters": { "type": "object", "description": "Custom launch parameters for the tool." }, "description": { "type": "string", "description": "The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters." }, "iconUrl": { "type": "string", "description": "The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL." }, "instructorCreated": { "type": "boolean", "description": "Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used" }, "key": { "type": "string", "description": "The key value" }, "launchInNewWindow": { "type": "boolean", "description": "Whether this placement link should be opened in a new window or not." }, "name": { "type": "string", "description": "The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters." }, "secret": { "type": "string", "description": "The secret value" }, "url": { "type": "string", "description": "The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL." } }, "required": [ "PCID", "placementId" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_courses\_by\_courseid\_assessments\_by\_assessmentid\_questions Create Question **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `courseId` | string | Yes | — | The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. \| ID type \| Example \| \|------------\|---------------------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:math101 \| \| courseId \| courseId:math101 \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| | | `assessmentId` | string | Yes | — | Assessment Id | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | | `correctResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is correct. | | `incorrectResponseFeedback` | string | No | — | Feedback displayed to students when their submitted response is incorrect. | | `instructorNotes` | string | No | — | Text added to the question as a note for the instructor. It is not intended to be displayed to students. | | `points` | number | No | — | The point value for the question. | | `position` | integer | No | — | Position of the Question on the Assessment Canvas. | | `questionHandler` | object | No | — | Question Handler | | `text` | string | Yes | — | The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor. | | `title` | string | No | — | The title of the question. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "courseId": { "type": "string", "description": "The course or organization ID. This may be the primary ID, or any of the secondary IDs prefixed with the ID type. | ID type | Example | |------------|---------------------------------------| | primary | _123_1 | | externalId | externalId:math101 | | courseId | courseId:math101 | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |" }, "assessmentId": { "type": "string", "description": "Assessment Id" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." }, "correctResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is correct." }, "incorrectResponseFeedback": { "type": "string", "description": "Feedback displayed to students when their submitted response is incorrect." }, "instructorNotes": { "type": "string", "description": "Text added to the question as a note for the instructor. It is not intended to be displayed to students." }, "points": { "type": "number", "description": "The point value for the question." }, "position": { "type": "integer", "description": "Position of the Question on the Assessment Canvas." }, "questionHandler": { "type": "object", "description": "Question Handler", "properties": { "type": { "type": "string", "description": "Type of Question supported. | Type | Description | --------- | --------- | | Presentation | **Since**: 3300.9.0 | | EitherOr | Read Only **Since**: 3300.9.0 | | Essay | Read Only **Since**: 3300.9.0 | | MultipleAnswer | Read Only **Since**: 3400.4.0 | | Numeric | Read Only **Since**: 3400.4.0 | | MultipleChoice | Read Only **Since**: 3400.4.0 | | Ordering | Read Only **Since**: 3400.4.0 | | Matching | Read Only **Since**: 3400.4.0 | | FillInTheBlank | Read Only **Since**: 3400.4.0 | | Calculated | Read Only **Since**: 3400.4.0 | | FileResponse | Read Only **Since**: 3400.4.0 | | LikertOpinionScale | Read Only **Since**: 3400.4.0 | | QuizBowl | Read Only **Since**: 3400.4.0 | | HotSpot | Read Only **Since**: 3400.4.0 | | JumbledSentence | Read Only **Since**: 3400.4.0 | | FillInTheBlankPlus | Read Only **Since**: 3400.4.0 | | QuestionBlock | Read Only **Since**: 3700.2.0 |", "enum": [ "Presentation", "EitherOr", "Essay", "MultipleAnswer", "Numeric", "MultipleChoice", "Ordering", "Matching", "FillInTheBlank", "Calculated", "FileResponse", "LikertOpinionScale", "QuizBowl", "HotSpot", "JumbledSentence", "FillInTheBlankPlus", "QuestionBlock" ] } } }, "text": { "type": "string", "description": "The main text content for the question. It may include plain and formatted text, and all kinds of content supported by the full text editor." }, "title": { "type": "string", "description": "The title of the question." } }, "required": [ "PCID", "courseId", "assessmentId", "text" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_lti\_domains Create Domain Config **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `allowGradesService` | boolean | No | — | Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0 | | `allowMembershipService` | boolean | No | — | Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships. | | `clientId` | string | No | — | The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0 | | `customParameters` | object | No | — | The custom parameters for the given domain. | | `description` | string | No | — | The description of the domain configuration **Since**: 3900.23.0 | | `jwksUrl` | string | No | — | The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `key` | string | No | — | The key value | | `name` | string | No | — | The name of the domain configuration **Since**: 3900.23.0 | | `primaryDomain` | string | No | — | The primary domain name associated with this configuration. | | `publicKey` | string | No | — | The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0 | | `secret` | string | No | — | The secret value | | `sendEmail` | boolean | No | — | Whether the user's email address can be sent to the LTI tool provider. | | `sendName` | boolean | No | — | Whether the user's name can be sent to the LTI tool provider. | | `sendRole` | boolean | No | — | Whether the user's role can be sent to the LTI tool provider. | | `sendUserDataType` | string | No | — | Enum indicating when user data can be sent to the LTI tool provider. \| Type \| Description \| --------- \| --------- \| \| Never \| \| \| Sslonly \| \| \| Always \| **Since**: 3300.9.0 \| | | `status` | string | No | — | Enum that indicates if the set of domains associated with this config can or cannot be linked to. \| Type \| Description \| --------- \| --------- \| \| Approved \| \| \| Excluded \| \| \| NeedsApproval \| **Since**: 3300.9.0 \| | | `useSplashScreen` | boolean | No | — | Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowGradesService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Assignment and Grades service and manage line items and grades. **Since**: 3600.0.0" }, "allowMembershipService": { "type": "boolean", "description": "Whether the Tool is allowed to call the LTI Names and Roles service and get the course memberships." }, "clientId": { "type": "string", "description": "The client id associated with this configuration. Only applicable for LTI versions 1.3+, excluding 2.0 **Since**: 3600.0.0" }, "customParameters": { "type": "object", "description": "The custom parameters for the given domain." }, "description": { "type": "string", "description": "The description of the domain configuration **Since**: 3900.23.0" }, "jwksUrl": { "type": "string", "description": "The JWKS URL of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "key": { "type": "string", "description": "The key value" }, "name": { "type": "string", "description": "The name of the domain configuration **Since**: 3900.23.0" }, "primaryDomain": { "type": "string", "description": "The primary domain name associated with this configuration." }, "publicKey": { "type": "string", "description": "The public key of the tool, if specified. It is optional and can be null **Since**: 3800.17.0" }, "secret": { "type": "string", "description": "The secret value" }, "sendEmail": { "type": "boolean", "description": "Whether the user's email address can be sent to the LTI tool provider." }, "sendName": { "type": "boolean", "description": "Whether the user's name can be sent to the LTI tool provider." }, "sendRole": { "type": "boolean", "description": "Whether the user's role can be sent to the LTI tool provider." }, "sendUserDataType": { "type": "string", "description": "Enum indicating when user data can be sent to the LTI tool provider. | Type | Description | --------- | --------- | | Never | | | Sslonly | | | Always | **Since**: 3300.9.0 |", "enum": [ "Never", "Sslonly", "Always" ] }, "status": { "type": "string", "description": "Enum that indicates if the set of domains associated with this config can or cannot be linked to. | Type | Description | --------- | --------- | | Approved | | | Excluded | | | NeedsApproval | **Since**: 3300.9.0 |", "enum": [ "Approved", "Excluded", "NeedsApproval" ] }, "useSplashScreen": { "type": "boolean", "description": "Whether a splash screen is shown before launching the LTI link. Cannot be set to true if allowMembershipService is true." } }, "required": [ "PCID" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_lti\_placements Create Placement **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `allowGrading` | boolean | No | — | Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum\[Type]#`ContentHandler` types. All others don't support grading and will be set to false. | | `allowStudents` | boolean | No | — | Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool. | | `authorId` | string | No | — | Id of the creator of the placement **Deprecated**: since 3900.0 not used | | `availability` | object | No | — | Settings controlling availability of the placement. | | `customParameters` | object | No | — | Custom launch parameters for the tool. | | `description` | string | No | — | The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD\_REQUEST error with message is returned if greater than 1000 characters. | | `handle` | string | Yes | — | The handle that uniquely identifies this placement. Required to be unique. Maximum length is 32 characters, BAD\_REQUEST error with message is returned if greater than 32 characters. | | `iconUrl` | string | No | — | The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD\_REQUEST error with message is returned if greater than 255 characters or incomplete URL. | | `instructorCreated` | boolean | No | — | Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used | | `key` | string | No | — | The key value | | `launchInNewWindow` | boolean | No | — | Whether this placement link should be opened in a new window or not. | | `name` | string | Yes | — | The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD\_REQUEST error with message is returned if greater than 50 characters. | | `secret` | string | No | — | The secret value | | `type` | string | Yes | — | The type of placement. \| Type \| Description \| --------- \| --------- \| \| Application \| Application or Student Tool Placement \| \| ContentHandler \| Content Type placement \| \| ContentItemMessage \| Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 \| \| System \| System-level Tools \| \| Administrator \| Administrator-level Tools **Since**: 3400.1.0 \| \| UltraUI \| Ultra-UI Extensions **Since**: 3700.6.0 \| \| BaseNavigation \| Base Navigation \| \| CourseNavigation \| Course Navigation \| \| Proctoring \| Proctoring **Since**: 3900.10.0 \| | | `url` | string | Yes | — | The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD\_REQUEST error with message is returned if greater than 1024 characters or incomplete URL. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "allowGrading": { "type": "boolean", "description": "Whether this placement can accept grades from the tool provider and a grade column can be created for it. This only applies to Enum[Type]#`ContentHandler` types. All others don't support grading and will be set to false." }, "allowStudents": { "type": "boolean", "description": "Whether the course tool is visible by students, or only to non-students (e.g. instructors). Defaults to true, allowing students to see the tool." }, "authorId": { "type": "string", "description": "Id of the creator of the placement **Deprecated**: since 3900.0 not used" }, "availability": { "type": "object", "description": "Settings controlling availability of the placement.", "properties": { "available": { "type": "string", "description": "Whether the placement is available within the system. | Type | Description | --------- | --------- | | Yes | | | No | |", "enum": [ "Yes", "No" ] } } }, "customParameters": { "type": "object", "description": "Custom launch parameters for the tool." }, "description": { "type": "string", "description": "The description of the placement. Not required to be unique. Maximum length is 1000 characters, BAD_REQUEST error with message is returned if greater than 1000 characters." }, "handle": { "type": "string", "description": "The handle that uniquely identifies this placement. Required to be unique. Maximum length is 32 characters, BAD_REQUEST error with message is returned if greater than 32 characters." }, "iconUrl": { "type": "string", "description": "The URL of the icon for this placement, if any. Not required to be unique, must be a complete and valid URL. Maximum length is 255 characters, BAD_REQUEST error with message is returned if greater than 255 characters or incomplete URL." }, "instructorCreated": { "type": "boolean", "description": "Whether an instructor created the placement or not (otherwise admin) **Deprecated**: since 3900.0 not used" }, "key": { "type": "string", "description": "The key value" }, "launchInNewWindow": { "type": "boolean", "description": "Whether this placement link should be opened in a new window or not." }, "name": { "type": "string", "description": "The name of the placement. Not required to be unique. Maximum length of 50 characters, BAD_REQUEST error with message is returned if greater than 50 characters." }, "secret": { "type": "string", "description": "The secret value" }, "type": { "type": "string", "description": "The type of placement. | Type | Description | --------- | --------- | | Application | Application or Student Tool Placement | | ContentHandler | Content Type placement | | ContentItemMessage | Content-item Message placement (see IMSGlobal spec) **Since**: 3300.5.0 | | System | System-level Tools | | Administrator | Administrator-level Tools **Since**: 3400.1.0 | | UltraUI | Ultra-UI Extensions **Since**: 3700.6.0 | | BaseNavigation | Base Navigation | | CourseNavigation | Course Navigation | | Proctoring | Proctoring **Since**: 3900.10.0 |", "enum": [ "Application", "ContentHandler", "ContentItemMessage", "System", "Administrator", "UltraUI", "BaseNavigation", "CourseNavigation", "Proctoring" ] }, "url": { "type": "string", "description": "The URL of the tool provider. Not required to be unique, must be a complete and valid URL. Maximum length is 1024 characters, BAD_REQUEST error with message is returned if greater than 1024 characters or incomplete URL." } }, "required": [ "PCID", "handle", "name", "type", "url" ] } ``` *** ## blackboard\_system\_post\_learn\_api\_public\_uploads Upload **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- | | `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "fields": { "type": "string", "description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned." } }, "required": [ "PCID" ] } ```