Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page

Was this helpful?

  1. Services
  2. Elevate Standards Alignment - AB Connect API
  3. Reference

Assets

PreviousConceptsNextAsset Definitions

Last updated 7 months ago

Was this helpful?

Academic Benchmarks refers to partner content and assessment items as Assets. In AB Connect, an Asset is the metadata that describes the content - not the actual content itself. The Assets resource can be used to perform a host of operations on partner Assets to allow you to manage and relate your Assets. You can create, modify and delete Assets. You can also build a metadata profile for your Assets which allow you to take advantage of the power of the AB Connect prediction engine to establish and maintain relationships between your Asset, Standards and other Assets. See the section on for a discussion on the licensing required for access to Assets.

In addition to the attributes and relationships built into AB Connect to support Content Enrichment and predictions, AB Connect allows you to define your own attributes to support needs such as advanced searching. These customer defined attributes are referred to as descriptors or custom attributes. They can be configured per Asset type either by you (if you have web access enabled for your account) or by .

Custom attributes are represented in the API in two ways: through the descriptors array or by direct named properties of the custom_attributes object property. The name of the property is defined in the Asset setup screens. The descriptors array was the initial implementation and has been kept for backwards compatibility but the direct named attributes are easier to work with (particularly when filtering) and are the recommended approach. To illustrate the payload for custom attributes, if the Asset type has a property named "Color", it will be represented in the descriptors array as an anonymous name/value pair like:

    "descriptors": [
        {
            "name": "Color",
            "value": "blue"
        }
    ],

However, it will also be represented as a named attribute like:

    "custom_attributes": {
        "color": ["blue"]
    },

A couple of key points:

  • When custom attributes are exchanged in JSON as named attributes, they are converted to lower case and any spaces or special characters are replaced by underscores. Multiple underscores in a row are collapsed into a single underscore. You won't need to think too much about this because the Asset type setup screen shows both the full property name and the JSON API attribute property name.

  • It is the responsibility of the client application to control the values of the custom attributes, so if you have single-valued properties or controlled vocabularies in your use case, ensure they are handled properly before sending the data to AB Connect.

  • The named attribute is an array. This is because custom attributes are multi-valued in AB Connect. In the descriptors array, this is represented by multiple anonymous objects with the same "name" and different "values". For example, if your Asset type is college logos, the University of Michigan Asset may have Color values of blue and yellow. The Color property would appear in the JSON as:

    "descriptors": [
        {
            "name": "Color",
            "value": "blue"
        },
        {
            "name": "Color",
            "value": "yellow"
        }
    ],

And:

    "custom_attributes": {
        "color": ["blue","yellow"]
    },

Creating an Asset

Creating an Asset

Retrieving Assets

Retrieving the Details of an Asset

Working with Assets

Modifying an Asset

To update an Asset, PATCH the Asset URL (with GUID) sending JSON in the body similar to that in the create statement. The JSON body only needs to contain the attributes that need to be updated. You cannot update the client_id or asset_type once the Asset is created. If one of those needs to change, you will need to delete the old Asset and create a new one.

Notes on PATCHing Assets:

  1. You do not need to include every field in a PATCH body. However, any field you include will replace the current value of that field on the Asset. For simple fields like title, that's not surprising. However, if you PATCH an object or array, you need to send the final state of that array or object - not just a single element. E.g. if the Asset has a descriptor with 5 name/value pairs on it and you send a PATCH to change 1 name/value pair, be sure to have copies of the other 4 name/value pairs in the descriptor array or the resulting Asset will only have one descriptor name/value pair.

  2. If you are doing a bulk update of Assets where you are requesting a large number of Assets, paging through the list and PATCHing the Assets as you page, be sure to sort the list on a field you are not modifying - preferably on a unique fields like the GUID. If you leave the sort order to the default (relevance) or sort on a field you are changing, you will likely get duplicate and skipped Assets as you page through the list.

Deleting Assets

Deleting an Asset

Assets can be deleted by sending a DELETE to their "self" URL.

Searching for Assets

To find Assets related to Standards, search based on the Standard GUID in the alignments.id field. E.g.

filter[assets]=(alignments.id eq '6B29DCD6-29EB-11D8-9C6E-A97B3BAEC73A')
filter[assets]=(alignments.id in ('6B29DCD6-29EB-11D8-9C6E-A97B3BAEC73A','6DF95514-36D9-11E6-B844-14D399AB8BA3'))

A similar approach can be applied to Topics and Concepts.

If you have your organization's identifier for the Asset, but not the AB GUID for it, you can retrieve the GUID by doing a search on client_id to locate the Asset. E.g.

filter[assets]=(client_id eq 'AJIH-45679')

Searching for Assets Owned by Another Provider

Assets include an owner relationship that references the object of the Provider to which the Asset belongs. By default, the Assets endpoint only searches the Assets you own. To search the Assets of other Providers, include owner.id in your filter criteria. You can get the IDs of the Owners to which you have access using the Providers endpoint. Alternatively, you can use the special keyword _all to search across all repositories to which you have access. E.g. filter[assets]=owner.id eq _all. You can also use the keyword _me to limit the search to just the Assets you own, but this is redundant with the approach of not specifying the owner.id at all.

Note that if you are including other Owners in your request, you can not include custom_attributes. Cross-owner searches can only operate on built-in properties.

Executing the Search

Finding Sets of Assets

Finally, all calls against the Asset resource must be implemented as HTTP GET, POST, DELETE or PATCH requests, and must include proper .

To create an Asset within the AB Connects system, you send a POST to the endpoint. The body of the POST contains the Asset definition in JSON format. The only required fields are client_id and asset_type. You can define your asset_type using the Academic Benchmarks web interface or have support set it up for you. If you do not know your asset_type or need to have one setup for you, contact for details.

Note: The Asset endpoint allows you to manipulate basic attributes of the Asset. To manage relationships, see the section on .

To work with an Asset, you've created, call the endpoint with a GET while supplying the AB GUID for the Asset. If you have your organization's ID for the Asset but not the AB GUID, see the section on and search on client_id to retrieve the AB GUID.

To work with an Asset you've created, call the endpoint while supplying the AB GUID for the Asset. If you have your organization's ID for the Asset but not the AB GUID, see the section on and search on client_id to retrieve the AB GUID.

To create and update relationships on assets, see the section on .

To delete an Asset you've created, call the endpoint while supplying the AB GUID for the Asset. If you have your organization's ID for the Asset but not the AB GUID, see the section on and search on client_id to retrieve the AB GUID.

Using filtering it is possible to retrieve sets of Assets that match specific criteria. These Assets are returned in an array of Asset objects. See the Introduction for an explanation on and . This section covers the specifics of using filtering with the Assets resource.

With AB Connect, it is possible to share your Assets with other AB Connect customers (Providers) to facilitate application interoperability. You can allow other Providers (the Consumer) to search sets of your Assets and retrieve the metadata profile describing your content. See the section on the endpoint for an overview.

Licensing Considerations
AB Support
Partner Authentication Credentials
AB Support
Providers
finding Assets
finding Assets
finding Assets
filtering
Managing and Predicting Relationships
Managing and Predicting Relationships
faceting
get
Path parameters
guidstringRequired

guid of specified asset

Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[assets]stringOptional

comma separated list of field names

includestringOptional

A comma separated list of resource names that will be returned in the response.

Responses
200
OK
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
404
Entity not found
application/json
get
GET /rest/v4.1/assets/{guid} HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*
{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 1
  },
  "data": {
    "relationships": {
      "alignment_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concepts": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "owner": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "deleted_alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "parent": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "topics": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concept_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      }
    },
    "id": "text",
    "attributes": {
      "prediction_algorithm": 1,
      "date_modified_utc": "text",
      "client_id": "text",
      "guid": "text",
      "custom_attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "education_levels": {
        "grades": [
          {
            "guid": "text",
            "descr": "text",
            "code": "text",
            "seq": 1
          }
        ]
      },
      "descriptors": [
        {
          "value": "text",
          "name": "text"
        }
      ],
      "title": "text",
      "date_alignments_modified_utc": "text",
      "disciplines": {
        "genres": [
          {
            "code": "text",
            "guid": "text",
            "descr": "text"
          }
        ],
        "ece_domains": [
          {
            "guid": "text",
            "code": "text",
            "descr": "text"
          }
        ],
        "strands": [
          {
            "descr": "text",
            "guid": "text"
          }
        ],
        "subjects": [
          {
            "code": "text",
            "descr": "text",
            "guid": "text"
          }
        ]
      },
      "asset_type": "text"
    },
    "type": "assets"
  },
  "included": [
    {
      "type": "text",
      "relationships": {
        "related_courses": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "breakout_origins": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "ancestors": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "topics": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "peers": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "breakouts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "crosswalks": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "replaced_by": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "replaces": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "children": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "concepts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "derivatives": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "origins": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "peer_derivatives": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "parent": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "course_standards": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "contexts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "associations": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      },
      "attributes": {
        "seq": 1,
        "captured_by": "text",
        "utilizations": [
          {
            "type": "alignable",
            "guid": "text"
          }
        ],
        "uri": "text",
        "statement": {
          "addendums": [
            {
              "seq": 1,
              "add_context": "Y",
              "descr": "text",
              "position": "before"
            }
          ],
          "combined_descr": "text",
          "descr": "text"
        },
        "level": 1,
        "date_modified_utc": "text",
        "status": "active",
        "legends": [
          {
            "symbol_position": "before",
            "symbol": "text",
            "descr": "text"
          }
        ],
        "standard_type": "organizational",
        "label": "text",
        "disciplines": {
          "strands": [
            {
              "descr": "text",
              "guid": "text"
            }
          ],
          "ece_domains": [
            {
              "guid": "text",
              "code": "text",
              "descr": "text"
            }
          ],
          "subjects": [
            {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          ],
          "genres": [
            {
              "code": "text",
              "guid": "text",
              "descr": "text"
            }
          ]
        },
        "alt_identifiers": [
          {
            "type": "GUID",
            "source": "canonical",
            "id": "text"
          }
        ],
        "date_deleted_utc": "text",
        "in_list": "Y",
        "guid": "text",
        "key_ideas": [
          {
            "guid": "text",
            "concepts": [
              {
                "descr": "text",
                "guid": "text"
              }
            ]
          }
        ],
        "document": {
          "implementation_year": "text",
          "descr": "text",
          "date_modified_utc": "text",
          "source_url": "text",
          "assessment_year": "text",
          "publication": {
            "descr": "text",
            "source_url": "text",
            "extended_descr": "text",
            "regions": [
              {
                "guid": "text",
                "descr": "text",
                "type": "country",
                "code": "text"
              }
            ],
            "authorities": [
              {
                "guid": "text",
                "descr": "text",
                "acronym": "text"
              }
            ],
            "acronym": "text",
            "publication_type": "standard",
            "guid": "text"
          },
          "guid": "text",
          "obsolete_year": "text",
          "disciplines": {
            "primary_subject": {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          },
          "adopt_year": "text",
          "revision_year": "text"
        },
        "deepest": "Y",
        "number": {
          "root_enhanced": "text",
          "enhanced": "text",
          "prefix_enhanced": "text",
          "raw": "text"
        },
        "education_levels": {
          "ece_ages": [
            {
              "guid": "text",
              "descr": "text",
              "seq": 1
            }
          ],
          "grades": [
            {
              "guid": "text",
              "descr": "text",
              "code": "text",
              "seq": 1
            }
          ]
        },
        "section": {
          "guid": "text",
          "seq": 1,
          "date_modified_utc": "text",
          "descr": "text",
          "implementation_year": "text",
          "number": "text",
          "assessment_year": "text",
          "revision_year": "text",
          "label": "text",
          "obsolete_year": "text",
          "adopt_year": "text",
          "disciplines": {
            "primary_subject": {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          }
        },
        "extensions": [
          {
            "type": "reference",
            "guid": "text",
            "descr": "text"
          }
        ],
        "has_list": "text",
        "topic_organizer": "text"
      },
      "id": "text"
    }
  ]
}
get
Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[assets]stringOptional

comma separated list of field names

filter[assets]stringOptional

an ODATA-like query string used to filter

filter[alignments]stringOptional

an ODATA-like query string used to filter

sort[assets]stringOptional

a comma separated list of property names specifying the sort order of the returned results

facetstringOptional

A comma separated list of facet names that you are requesting the options on.

facet_summarystringOptional

A comma separated list of facet names for which you are requesting summary information.

includestringOptional

A comma separated list of resource names that will be returned in the response.

limitnumberOptional

The page size for the response dataset. limit must be 100 or less.

offsetnumberOptional

How far into the dataset you are paging

Responses
200
OK
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
get
GET /rest/v4.1/assets HTTP/1.1
Host: api.abconnect.instructure.com
Accept: */*
{
  "links": {
    "self": "text",
    "first": "text",
    "last": "text",
    "next": "text",
    "prev": "text"
  },
  "meta": {
    "took": 1,
    "limit": 1,
    "count": 1,
    "offset": 1,
    "facets": [
      {
        "count": 1,
        "facet": "text",
        "details": [
          {
            "data": {
              "descr": "text",
              "code": "text",
              "guid": "text"
            },
            "count": 1
          }
        ]
      }
    ]
  },
  "data": [
    {
      "relationships": {
        "alignment_donors": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "concepts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "owner": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "deleted_alignments": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "parent": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "topics": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "alignments": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "concept_donors": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      },
      "id": "text",
      "attributes": {
        "prediction_algorithm": 1,
        "date_modified_utc": "text",
        "client_id": "text",
        "guid": "text",
        "custom_attributes": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "education_levels": {
          "grades": [
            {
              "guid": "text",
              "descr": "text",
              "code": "text",
              "seq": 1
            }
          ]
        },
        "descriptors": [
          {
            "value": "text",
            "name": "text"
          }
        ],
        "title": "text",
        "date_alignments_modified_utc": "text",
        "disciplines": {
          "genres": [
            {
              "code": "text",
              "guid": "text",
              "descr": "text"
            }
          ],
          "ece_domains": [
            {
              "guid": "text",
              "code": "text",
              "descr": "text"
            }
          ],
          "strands": [
            {
              "descr": "text",
              "guid": "text"
            }
          ],
          "subjects": [
            {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          ]
        },
        "asset_type": "text"
      },
      "type": "assets"
    }
  ],
  "included": [
    {
      "type": "text",
      "relationships": {
        "related_courses": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "breakout_origins": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "ancestors": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "topics": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "peers": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "breakouts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "crosswalks": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "replaced_by": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "replaces": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "children": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "concepts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "derivatives": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "origins": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "peer_derivatives": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "parent": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "course_standards": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "contexts": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        },
        "associations": {
          "data": [
            {
              "type": "text",
              "id": "text"
            }
          ],
          "links": {
            "related": "text"
          }
        }
      },
      "attributes": {
        "seq": 1,
        "captured_by": "text",
        "utilizations": [
          {
            "type": "alignable",
            "guid": "text"
          }
        ],
        "uri": "text",
        "statement": {
          "addendums": [
            {
              "seq": 1,
              "add_context": "Y",
              "descr": "text",
              "position": "before"
            }
          ],
          "combined_descr": "text",
          "descr": "text"
        },
        "level": 1,
        "date_modified_utc": "text",
        "status": "active",
        "legends": [
          {
            "symbol_position": "before",
            "symbol": "text",
            "descr": "text"
          }
        ],
        "standard_type": "organizational",
        "label": "text",
        "disciplines": {
          "strands": [
            {
              "descr": "text",
              "guid": "text"
            }
          ],
          "ece_domains": [
            {
              "guid": "text",
              "code": "text",
              "descr": "text"
            }
          ],
          "subjects": [
            {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          ],
          "genres": [
            {
              "code": "text",
              "guid": "text",
              "descr": "text"
            }
          ]
        },
        "alt_identifiers": [
          {
            "type": "GUID",
            "source": "canonical",
            "id": "text"
          }
        ],
        "date_deleted_utc": "text",
        "in_list": "Y",
        "guid": "text",
        "key_ideas": [
          {
            "guid": "text",
            "concepts": [
              {
                "descr": "text",
                "guid": "text"
              }
            ]
          }
        ],
        "document": {
          "implementation_year": "text",
          "descr": "text",
          "date_modified_utc": "text",
          "source_url": "text",
          "assessment_year": "text",
          "publication": {
            "descr": "text",
            "source_url": "text",
            "extended_descr": "text",
            "regions": [
              {
                "guid": "text",
                "descr": "text",
                "type": "country",
                "code": "text"
              }
            ],
            "authorities": [
              {
                "guid": "text",
                "descr": "text",
                "acronym": "text"
              }
            ],
            "acronym": "text",
            "publication_type": "standard",
            "guid": "text"
          },
          "guid": "text",
          "obsolete_year": "text",
          "disciplines": {
            "primary_subject": {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          },
          "adopt_year": "text",
          "revision_year": "text"
        },
        "deepest": "Y",
        "number": {
          "root_enhanced": "text",
          "enhanced": "text",
          "prefix_enhanced": "text",
          "raw": "text"
        },
        "education_levels": {
          "ece_ages": [
            {
              "guid": "text",
              "descr": "text",
              "seq": 1
            }
          ],
          "grades": [
            {
              "guid": "text",
              "descr": "text",
              "code": "text",
              "seq": 1
            }
          ]
        },
        "section": {
          "guid": "text",
          "seq": 1,
          "date_modified_utc": "text",
          "descr": "text",
          "implementation_year": "text",
          "number": "text",
          "assessment_year": "text",
          "revision_year": "text",
          "label": "text",
          "obsolete_year": "text",
          "adopt_year": "text",
          "disciplines": {
            "primary_subject": {
              "code": "text",
              "descr": "text",
              "guid": "text"
            }
          }
        },
        "extensions": [
          {
            "type": "reference",
            "guid": "text",
            "descr": "text"
          }
        ],
        "has_list": "text",
        "topic_organizer": "text"
      },
      "id": "text"
    }
  ]
}
  • Creating an Asset
  • Creating an Asset
  • POST/assets
  • Retrieving Assets
  • Retrieving the Details of an Asset
  • GET/assets/{guid}
  • Working with Assets
  • Modifying an Asset
  • PATCH/assets/{guid}
  • Deleting Assets
  • Deleting an Asset
  • Searching for Assets
  • Searching for Assets Owned by Another Provider
  • Executing the Search
  • Finding Sets of Assets
  • GET/assets
post
Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

fields[assets]stringOptional

comma separated list of field names

Body
Responses
201
Created
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
409
Conflict
application/json
422
Unprocessable content
application/json
post
POST /rest/v4.1/assets HTTP/1.1
Host: api.abconnect.instructure.com
Content-Type: application/json
Accept: */*
Content-Length: 428

{
  "data": {
    "type": "text",
    "attributes": {
      "title": "text",
      "descriptors": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "disciplines": {
        "subjects": [
          {
            "guid": "text",
            "code": "text"
          }
        ],
        "strands": [
          {
            "guid": "text"
          }
        ],
        "ece_domains": [
          {
            "guid": "text",
            "code": "text"
          }
        ],
        "genres": [
          {
            "guid": "text",
            "descr": "text",
            "code": "text"
          }
        ]
      },
      "education_levels": {
        "grades": [
          {
            "guid": "text",
            "code": "text"
          }
        ]
      },
      "client_id": "text",
      "asset_type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}
{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 1
  },
  "data": {
    "relationships": {
      "alignment_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concepts": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "owner": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "deleted_alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "parent": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "topics": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concept_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      }
    },
    "id": "text",
    "attributes": {
      "prediction_algorithm": 1,
      "date_modified_utc": "text",
      "client_id": "text",
      "guid": "text",
      "custom_attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "education_levels": {
        "grades": [
          {
            "guid": "text",
            "descr": "text",
            "code": "text",
            "seq": 1
          }
        ]
      },
      "descriptors": [
        {
          "value": "text",
          "name": "text"
        }
      ],
      "title": "text",
      "date_alignments_modified_utc": "text",
      "disciplines": {
        "genres": [
          {
            "code": "text",
            "guid": "text",
            "descr": "text"
          }
        ],
        "ece_domains": [
          {
            "guid": "text",
            "code": "text",
            "descr": "text"
          }
        ],
        "strands": [
          {
            "descr": "text",
            "guid": "text"
          }
        ],
        "subjects": [
          {
            "code": "text",
            "descr": "text",
            "guid": "text"
          }
        ]
      },
      "asset_type": "text"
    },
    "type": "assets"
  }
}
patch
Path parameters
guidstringRequired

guid of specified asset

Query parameters
partner.idstringRequired

Your partner ID - you should have gotten them from AB Support or when you signed up for a sandbox account.

auth.signaturestringRequired

Signature for the request authorization.

auth.expiresstringRequired

Expiration timestamp for the authorization.

Body
Responses
200
OK
application/json
400
Bad Request
application/json
401
Authentication Error
application/json
409
Conflict
application/json
422
Unprocessable content
application/json
patch
PATCH /rest/v4.1/assets/{guid} HTTP/1.1
Host: api.abconnect.instructure.com
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "data": {
    "type": "text",
    "attributes": {
      "title": "text",
      "descriptors": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "disciplines": {
        "subjects": [
          {
            "guid": "text",
            "code": "text"
          }
        ],
        "strands": [
          {
            "guid": "text"
          }
        ],
        "ece_domains": [
          {
            "guid": "text",
            "code": "text"
          }
        ],
        "genres": [
          {
            "guid": "text",
            "descr": "text",
            "code": "text"
          }
        ]
      },
      "education_levels": {
        "grades": [
          {
            "guid": "text",
            "code": "text"
          }
        ]
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}
{
  "links": {
    "self": "text"
  },
  "meta": {
    "took": 1
  },
  "data": {
    "relationships": {
      "alignment_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concepts": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "owner": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "deleted_alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "parent": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "topics": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "alignments": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      },
      "concept_donors": {
        "data": [
          {
            "type": "text",
            "id": "text"
          }
        ],
        "links": {
          "related": "text"
        }
      }
    },
    "id": "text",
    "attributes": {
      "prediction_algorithm": 1,
      "date_modified_utc": "text",
      "client_id": "text",
      "guid": "text",
      "custom_attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "education_levels": {
        "grades": [
          {
            "guid": "text",
            "descr": "text",
            "code": "text",
            "seq": 1
          }
        ]
      },
      "descriptors": [
        {
          "value": "text",
          "name": "text"
        }
      ],
      "title": "text",
      "date_alignments_modified_utc": "text",
      "disciplines": {
        "genres": [
          {
            "code": "text",
            "guid": "text",
            "descr": "text"
          }
        ],
        "ece_domains": [
          {
            "guid": "text",
            "code": "text",
            "descr": "text"
          }
        ],
        "strands": [
          {
            "descr": "text",
            "guid": "text"
          }
        ],
        "subjects": [
          {
            "code": "text",
            "descr": "text",
            "guid": "text"
          }
        ]
      },
      "asset_type": "text"
    },
    "type": "assets"
  }
}