Tags

Show all tags for the given media

get

Authorizations

UserSession

AuthorizationstringRequired

Path parameters

media_idinteger · int64Required

The ID of the media.

Responses

201

The tag object(s) for the given media.

application/json

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The media was not found by ID.

get

/media/{media_id}/tags

HTTPcURLJavaScriptPython

GET /api/public/v1/media/{media_id}/tags HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ]
}

Create a new tag for the given media

post

Authorizations

UserSession

AuthorizationstringRequired

Path parameters

media_idinteger · int64Required

The ID of the media.

Query parameters

namestringRequired

The name of the tag.

Responses

201

The tag object that was created.

application/json

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The media was not found by ID.

post

/media/{media_id}/tags

HTTPcURLJavaScriptPython

POST /api/public/v1/media/{media_id}/tags?name=text HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "tag": {
    "id": 1,
    "name": "text"
  }
}

Delete a tag by its id

delete

Authorizations

UserSession

AuthorizationstringRequired

Path parameters

media_idinteger · int64Required

The ID of the media.

tag_idinteger · int64Required

The ID of the tag.

Responses

200

The media tag has been deleted.

No content

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The media or tag ID was not found.

delete

/media/{media_id}/tags/{tag_id}

HTTPcURLJavaScriptPython

DELETE /api/public/v1/media/{media_id}/tags/{tag_id} HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

No content