> ## 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-institutional
> Blackboard Institutional - hierarchy, attendance, terms, and SIS logs
**Server path:** `/blackboard-institutional` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings) | Delete All Meetings In Course |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Delete Course Meeting |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Delete All Records In Meeting |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Delete Attendance Record |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid) | Delete All Attendance Records By Course And User Id |
| [`blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid_all`](#blackboard_institutional_delete_learn_api_public_courses_by_courseid_meetings_users_by_userid_all) | Delete All Attendance By User Id |
| [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Delete Node |
| [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Delete Node Course Association |
| [`blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid`](#blackboard_institutional_delete_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid) | Delete Node User Association |
| [`blackboard_institutional_delete_learn_api_public_terms_by_termid`](#blackboard_institutional_delete_learn_api_public_terms_by_termid) | Delete Term |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings) | Get Course Meetings |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Get Course Meeting |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Get Attendance Records By Meeting Id |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Get Attendance Record |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_downloadurl`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_downloadurl) | Generate Attendance Data Download Url |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_users_by_userid`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_meetings_users_by_userid) | Get Attendance Records By User Id |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_nodes`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_nodes) | Get Nodes For Course |
| [`blackboard_institutional_get_learn_api_public_courses_by_courseid_performance_contentreviewstatus`](#blackboard_institutional_get_learn_api_public_courses_by_courseid_performance_contentreviewstatus) | Get Review Status By Course Id |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes) | Get Nodes |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Get Node |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children) | Get Node Children |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses) | Get Node Course Associations |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype) | Get Tools |
| [`blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users`](#blackboard_institutional_get_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users) | Get Node User Associations |
| [`blackboard_institutional_get_learn_api_public_logs_sis_datasets_by_id`](#blackboard_institutional_get_learn_api_public_logs_sis_datasets_by_id) | Get SIS Logs By Data Set Uid |
| [`blackboard_institutional_get_learn_api_public_terms`](#blackboard_institutional_get_learn_api_public_terms) | Get Terms |
| [`blackboard_institutional_get_learn_api_public_terms_by_termid`](#blackboard_institutional_get_learn_api_public_terms_by_termid) | Get Term |
| [`blackboard_institutional_get_learn_api_public_users_by_userid_nodes`](#blackboard_institutional_get_learn_api_public_users_by_userid_nodes) | Get Nodes For User |
| [`blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid`](#blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid) | Update Course Meeting |
| [`blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid`](#blackboard_institutional_patch_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_by_userid) | Update Attendance Record |
| [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid) | Update Node |
| [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Update Node Course Association |
| [`blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype_by_toolid`](#blackboard_institutional_patch_learn_api_public_institutionalhierarchy_nodes_by_nodeid_tools_by_tooltype_by_toolid) | Patch Tool |
| [`blackboard_institutional_patch_learn_api_public_terms_by_termid`](#blackboard_institutional_patch_learn_api_public_terms_by_termid) | Update Term |
| [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings) | Create Course Meeting |
| [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users) | Create Attendance Record |
| [`blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_bulk`](#blackboard_institutional_post_learn_api_public_courses_by_courseid_meetings_by_meetingid_users_bulk) | Update Attendance Records |
| [`blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes`](#blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes) | Create Node |
| [`blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children`](#blackboard_institutional_post_learn_api_public_institutionalhierarchy_nodes_by_nodeid_children) | Create Child Node |
| [`blackboard_institutional_post_learn_api_public_terms`](#blackboard_institutional_post_learn_api_public_terms) | Create Term |
| [`blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid`](#blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_courses_by_courseid) | Create Node Course Association |
| [`blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid`](#blackboard_institutional_put_learn_api_public_institutionalhierarchy_nodes_by_nodeid_users_by_userid) | Create Node Course Association |
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings
Delete All Meetings In Course
**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 \| |
```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 |"
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid
Delete Course Meeting
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
}
},
"required": [
"PCID",
"courseId",
"meetingId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users
Delete All Records In Meeting
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
}
},
"required": [
"PCID",
"courseId",
"meetingId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid
Delete Attendance Record
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"courseId",
"meetingId",
"userId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid
Delete All Attendance Records By Course And User 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid\_all
Delete All Attendance By User 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 \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```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 |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"courseId",
"userId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid
Delete Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid
Delete Node Course Association
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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 |"
}
},
"required": [
"PCID",
"nodeId",
"courseId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users\_by\_userid
Delete Node User Association
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
}
},
"required": [
"PCID",
"nodeId",
"userId"
]
}
```
***
## blackboard\_institutional\_delete\_learn\_api\_public\_terms\_by\_termid
Delete Term
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"termId": {
"type": "string",
"description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |"
}
},
"required": [
"PCID",
"termId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings
Get Course Meetings
**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. |
| `sort` | string | No | — | Sort order for results |
| `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 \| |
| `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."
},
"sort": {
"type": "string",
"description": "Sort order for results"
},
"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 |"
},
"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"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid
Get Course Meeting
**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 \| |
| `meetingId` | string | Yes | — | Meeting 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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting 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",
"meetingId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users
Get Attendance Records By Meeting Id
**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. |
| `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 \| |
| `sort` | string | No | — | Sort order for results |
| `meetingId` | string | Yes | — | Meeting 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"
},
"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."
},
"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 |"
},
"sort": {
"type": "string",
"description": "Sort order for results"
},
"meetingId": {
"type": "string",
"description": "Meeting 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",
"meetingId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid
Get Attendance Record
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"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",
"meetingId",
"userId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_downloadurl
Generate Attendance Data Download Url
**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 \| |
| `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 |"
},
"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"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_meetings\_users\_by\_userid
Get Attendance Records By User Id
**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. |
| `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 \| |
| `sort` | string | No | — | Sort order for results |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `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."
},
"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 |"
},
"sort": {
"type": "string",
"description": "Sort order for results"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"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",
"userId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_nodes
Get Nodes For Course
**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 \| |
| `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. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```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 |"
},
"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."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"courseId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_courses\_by\_courseid\_performance\_contentreviewstatus
Get Review Status By Course 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 \| |
| `userId` | string | No | — | Optional search criteria to filter by user id. **Since**: 3700.15.0 |
| `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 |"
},
"userId": {
"type": "string",
"description": "Optional search criteria to filter by user id. **Since**: 3700.15.0"
},
"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"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes
Get Nodes
**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. |
| `recursive` | boolean | No | — | Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.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."
},
"recursive": {
"type": "boolean",
"description": "Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.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\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid
Get Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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",
"nodeId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_children
Get Node Children
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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. |
| `recursive` | boolean | No | — | Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.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"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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."
},
"recursive": {
"type": "boolean",
"description": "Search Institutional Hierarchy Nodes recursively. If true, returns all descendant nodes of the specified Node. If false, only immediate children are returned (defualt: false) **Since**: 3800.14.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",
"nodeId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses
Get Node Course Associations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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. |
| `course.organization` | boolean | No | — | Filters Hierarchy Node associations based on whether it is a Node-Course or a Node-Organization association. A value of 'true' indicates that search results should be limited to Node-Organization associations. A value of 'false' indicates results should be limited to Node-Course associations. Not setting this field indicates that both Node-Course and Node-Organization associations should be returned. |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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."
},
"course.organization": {
"type": "boolean",
"description": "Filters Hierarchy Node associations based on whether it is a Node-Course or a Node-Organization association. A value of 'true' indicates that search results should be limited to Node-Organization associations. A value of 'false' indicates results should be limited to Node-Course associations. Not setting this field indicates that both Node-Course and Node-Organization associations should be returned."
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_tools\_by\_tooltype
Get Tools
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `toolType` | string | Yes | — | Tool Type |
| `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"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"toolType": {
"type": "string",
"description": "Tool Type",
"enum": [
"Course",
"Organization",
"Content"
]
},
"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",
"nodeId",
"toolType"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users
Get Node User Associations
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_logs\_sis\_datasets\_by\_id
Get SIS Logs By Data Set Uid
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | : dataSetUid of the integration |
| `level` | string | No | — | : Logs can be filtered with level. Default level is Error. Logs will be pulled of that level and above i.e. for level = Warning result set will have warning and error level log messages |
| `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"
},
"id": {
"type": "string",
"description": ": dataSetUid of the integration"
},
"level": {
"type": "string",
"description": ": Logs can be filtered with level. Default level is Error. Logs will be pulled of that level and above i.e. for level = Warning result set will have warning and error level log messages",
"enum": [
"Debug",
"Information",
"Warning",
"Error"
]
},
"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",
"id"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_terms
Get Terms
**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. |
| `externalId` | string | No | — | Search for term with externalId properties that contain this value. **Since**: 3100.6.0 |
| `dataSourceId` | string | No | — | Search for term with this dataSourceId. **Since**: 3100.6.0 |
| `availability.available` | string | No | — | Search for users with availability.available properties that contain this value. **Since**: 3100.6.0 \| Type \| Description \| --------- \| --------- \| \| Yes \| Students may access the term and the courses it contains. \| \| No \| Students may not access the term or the courses it contains. \| |
| `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."
},
"externalId": {
"type": "string",
"description": "Search for term with externalId properties that contain this value. **Since**: 3100.6.0"
},
"dataSourceId": {
"type": "string",
"description": "Search for term with this dataSourceId. **Since**: 3100.6.0"
},
"availability.available": {
"type": "string",
"description": "Search for users with availability.available properties that contain this value. **Since**: 3100.6.0 | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |",
"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\_institutional\_get\_learn\_api\_public\_terms\_by\_termid
Get Term
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| |
| `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"
},
"termId": {
"type": "string",
"description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |"
},
"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",
"termId"
]
}
```
***
## blackboard\_institutional\_get\_learn\_api\_public\_users\_by\_userid\_nodes
Get Nodes For User
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `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. |
| `expand` | string | No | — | A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:\
\ |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"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."
},
"expand": {
"type": "string",
"description": "A comma-delimited list of fields to expand as part of the response. Expanded fields may cause additional load time. Supported fields are:
"
}
},
"required": [
"PCID",
"userId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid
Update Course Meeting
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `description` | string | No | — | The description of the meeting |
| `end` | string | No | — | The end time of meeting |
| `externalLink` | string | No | — | The externalLink of course meeting |
| `start` | string | No | — | The start time of meeting |
| `title` | string | No | — | The title of the meeting |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "The description of the meeting"
},
"end": {
"type": "string",
"description": "The end time of meeting"
},
"externalLink": {
"type": "string",
"description": "The externalLink of course meeting"
},
"start": {
"type": "string",
"description": "The start time of meeting"
},
"title": {
"type": "string",
"description": "The title of the meeting"
}
},
"required": [
"PCID",
"courseId",
"meetingId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_by\_userid
Update Attendance Record
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `status` | string | No | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"status": {
"type": "string",
"description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |",
"enum": [
"Absent",
"Late",
"Present",
"Excused"
]
}
},
"required": [
"PCID",
"courseId",
"meetingId",
"userId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid
Update Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `description` | string | No | — | Node description |
| `externalId` | string | No | — | Node unique identifier |
| `title` | string | No | — | Node display name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "Node description"
},
"externalId": {
"type": "string",
"description": "Node unique identifier"
},
"title": {
"type": "string",
"description": "Node display name"
}
},
"required": [
"PCID",
"nodeId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid
Update Node Course Association
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `isPrimary` | boolean | No | — | Whether or not this association represents the primary node association of the course |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"isPrimary": {
"type": "boolean",
"description": "Whether or not this association represents the primary node association of the course"
}
},
"required": [
"PCID",
"nodeId",
"courseId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_tools\_by\_tooltype\_by\_toolid
Patch Tool
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `toolType` | string | Yes | — | Tool Type |
| `toolId` | string | Yes | — | Tool Id |
| `updateExistingOriginalCourses` | boolean | No | — | Scope of updated Tool Settings. By default if the parameter is not present or is set as false, the updated settings will be applied to new Original courses and all Ultra courses (new and existing). If present and value is true, the updated settings will be applied to all new and existing courses (Original and Ultra). **Since**: 3900.16.0 |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `guestSettings` | object | No | — | Guest Settings |
| `observerSettings` | object | No | — | Observer Settings |
| `toolSettings` | object | No | — | Tool Settings |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"toolType": {
"type": "string",
"description": "Tool Type",
"enum": [
"Course",
"Organization",
"Content"
]
},
"toolId": {
"type": "string",
"description": "Tool Id"
},
"updateExistingOriginalCourses": {
"type": "boolean",
"description": "Scope of updated Tool Settings. By default if the parameter is not present or is set as false, the updated settings will be applied to new Original courses and all Ultra courses (new and existing). If present and value is true, the updated settings will be applied to all new and existing courses (Original and Ultra). **Since**: 3900.16.0"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"guestSettings": {
"type": "object",
"description": "Guest Settings",
"properties": {
"available": {
"type": "boolean",
"description": "Whether the tool is available."
},
"locked": {
"type": "boolean",
"description": "Whether the tool is locked."
},
"applicable": {
"type": "boolean",
"description": "Whether the available and locked settings are applicable."
}
}
},
"observerSettings": {
"type": "object",
"description": "Observer Settings",
"properties": {
"available": {
"type": "boolean",
"description": "Whether the tool is available."
},
"locked": {
"type": "boolean",
"description": "Whether the tool is locked."
},
"applicable": {
"type": "boolean",
"description": "Whether the available and locked settings are applicable."
}
}
},
"toolSettings": {
"type": "object",
"description": "Tool Settings",
"properties": {
"available": {
"type": "boolean",
"description": "Whether the tool is available."
},
"locked": {
"type": "boolean",
"description": "Whether the tool is locked."
},
"applicable": {
"type": "boolean",
"description": "Whether the available and locked settings are applicable."
}
}
}
},
"required": [
"PCID",
"nodeId",
"toolType",
"toolId"
]
}
```
***
## blackboard\_institutional\_patch\_learn\_api\_public\_terms\_by\_termid
Update Term
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `termId` | string | Yes | — | The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. \| ID type \| Example \| \|------------\|------------------------\| \| primary \| \_123\_1 \| \| externalId \| externalId:spring.2016 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `availability` | object | No | — | Settings controlling availability of the term to students. |
| `dataSourceId` | string | No | — | The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax "externalId:math101". |
| `description` | string | No | — | The description of the term. This field supports BbML; see \ for more information. |
| `externalId` | string | No | — | An externally-defined unique ID for the term. Formerly known as 'sourcedidId'. |
| `name` | string | No | — | The name of the term. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"termId": {
"type": "string",
"description": "The term ID. This may be the primary ID, or the secondary ID prefixed with the ID type. | ID type | Example | |------------|------------------------| | primary | _123_1 | | externalId | externalId:spring.2016 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the term to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the term and the courses it contains are available to students. Instructors can always access their courses. | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |",
"enum": [
"Yes",
"No"
]
},
"duration": {
"type": "object",
"description": "Settings controlling the length of time the term is available."
}
}
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
},
"description": {
"type": "string",
"description": "The description of the term. This field supports BbML; see here for more information."
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the term. Formerly known as 'sourcedidId'."
},
"name": {
"type": "string",
"description": "The name of the term."
}
},
"required": [
"PCID",
"termId"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings
Create Course Meeting
**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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `description` | string | Yes | — | The description of the meeting |
| `end` | string | Yes | — | The end time of meeting |
| `externalLink` | string | No | — | The externalLink of course meeting |
| `start` | string | Yes | — | The start time of meeting |
| `title` | string | Yes | — | The title of the meeting |
```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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "The description of the meeting"
},
"end": {
"type": "string",
"description": "The end time of meeting"
},
"externalLink": {
"type": "string",
"description": "The externalLink of course meeting"
},
"start": {
"type": "string",
"description": "The start time of meeting"
},
"title": {
"type": "string",
"description": "The title of the meeting"
}
},
"required": [
"PCID",
"courseId",
"description",
"end",
"start",
"title"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users
Create Attendance Record
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `status` | string | Yes | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| |
| `userId` | string | Yes | — | The learn external id of the user. |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"status": {
"type": "string",
"description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |",
"enum": [
"Absent",
"Late",
"Present",
"Excused"
]
},
"userId": {
"type": "string",
"description": "The learn external id of the user."
}
},
"required": [
"PCID",
"courseId",
"meetingId",
"status",
"userId"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_courses\_by\_courseid\_meetings\_by\_meetingid\_users\_bulk
Update Attendance Records
**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 \| |
| `meetingId` | string | Yes | — | Meeting Id |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `status` | string | Yes | — | The attendance status of the user. \| Type \| Description \| --------- \| --------- \| \| Absent \| \| \| Late \| \| \| Present \| \| \| Excused \| \| |
| `userId` | string | Yes | — | The learn external id of the user. |
```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 |"
},
"meetingId": {
"type": "string",
"description": "Meeting Id"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"status": {
"type": "string",
"description": "The attendance status of the user. | Type | Description | --------- | --------- | | Absent | | | Late | | | Present | | | Excused | |",
"enum": [
"Absent",
"Late",
"Present",
"Excused"
]
},
"userId": {
"type": "string",
"description": "The learn external id of the user."
}
},
"required": [
"PCID",
"courseId",
"meetingId",
"status",
"userId"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_institutionalhierarchy\_nodes
Create Node
**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. |
| `description` | string | No | — | Node description |
| `externalId` | string | No | — | Node unique identifier |
| `title` | string | Yes | — | Node display name |
```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."
},
"description": {
"type": "string",
"description": "Node description"
},
"externalId": {
"type": "string",
"description": "Node unique identifier"
},
"title": {
"type": "string",
"description": "Node display name"
}
},
"required": [
"PCID",
"title"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_children
Create Child Node
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `description` | string | No | — | Node description |
| `externalId` | string | No | — | Node unique identifier |
| `title` | string | Yes | — | Node display name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"description": {
"type": "string",
"description": "Node description"
},
"externalId": {
"type": "string",
"description": "Node unique identifier"
},
"title": {
"type": "string",
"description": "Node display name"
}
},
"required": [
"PCID",
"nodeId",
"title"
]
}
```
***
## blackboard\_institutional\_post\_learn\_api\_public\_terms
Create Term
**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. |
| `availability` | object | No | — | Settings controlling availability of the term to students. |
| `dataSourceId` | string | No | — | The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax "externalId:math101". |
| `description` | string | No | — | The description of the term. This field supports BbML; see \ for more information. |
| `externalId` | string | Yes | — | An externally-defined unique ID for the term. Formerly known as 'sourcedidId'. |
| `name` | string | Yes | — | The name of the term. |
```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."
},
"availability": {
"type": "object",
"description": "Settings controlling availability of the term to students.",
"properties": {
"available": {
"type": "string",
"description": "Whether the term and the courses it contains are available to students. Instructors can always access their courses. | Type | Description | --------- | --------- | | Yes | Students may access the term and the courses it contains. | | No | Students may not access the term or the courses it contains. |",
"enum": [
"Yes",
"No"
]
},
"duration": {
"type": "object",
"description": "Settings controlling the length of time the term is available."
}
}
},
"dataSourceId": {
"type": "string",
"description": "The ID of the data source associated with this term. This may optionally be the data source's externalId using the syntax \"externalId:math101\"."
},
"description": {
"type": "string",
"description": "The description of the term. This field supports BbML; see here for more information."
},
"externalId": {
"type": "string",
"description": "An externally-defined unique ID for the term. Formerly known as 'sourcedidId'."
},
"name": {
"type": "string",
"description": "The name of the term."
}
},
"required": [
"PCID",
"externalId",
"name"
]
}
```
***
## blackboard\_institutional\_put\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_courses\_by\_courseid
Create Node Course Association
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `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 \| |
| `fields` | string | No | — | A comma-delimited list of fields to include in the response. If not specified, all fields will be returned. |
| `isPrimary` | boolean | No | — | Whether or not this association represents the primary node association of the course |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"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 |"
},
"fields": {
"type": "string",
"description": "A comma-delimited list of fields to include in the response. If not specified, all fields will be returned."
},
"isPrimary": {
"type": "boolean",
"description": "Whether or not this association represents the primary node association of the course"
}
},
"required": [
"PCID",
"nodeId",
"courseId"
]
}
```
***
## blackboard\_institutional\_put\_learn\_api\_public\_institutionalhierarchy\_nodes\_by\_nodeid\_users\_by\_userid
Create Node Course Association
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `nodeId` | string | Yes | — | The node 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:breakfastClub \| |
| `userId` | string | Yes | — | The user 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:jsmith \| \| userName \| userName:jsmith \| \| uuid \| uuid:915c7567d76d444abf1eed56aad3beb5 \| |
| `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"
},
"nodeId": {
"type": "string",
"description": "The node 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:breakfastClub |"
},
"userId": {
"type": "string",
"description": "The user 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:jsmith | | userName | userName:jsmith | | uuid | uuid:915c7567d76d444abf1eed56aad3beb5 |"
},
"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",
"nodeId",
"userId"
]
}
```