Update CourseItemSurvey

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (CourseItemSurvey)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CourseItemSurvey

Example:

CourseItemSurvey

attributes

object

optional

relationships

object

optional

Example

{
  "data": {
    "id": "FID001",
    "type": "CourseItemSurvey",
    "attributes": {
      "title": "string",
      "description": "string",
      "customLabel": "string",
      "isReviewRequired": true
    },
    "relationships": {
      "folder": {
        "data": {
          "id": "FID001",
          "type": "CourseFolder"
        }
      },
      "survey": {
        "data": {
          "id": "FID001",
          "type": "Survey"
        }
      }
    }
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (CourseItemSurvey)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

CourseItemSurvey

Example:

CourseItemSurvey

attributes

object

optional

relationships

object

optional

Example

{
  "data": {
    "id": "FID001",
    "type": "CourseItemSurvey",
    "attributes": {
      "title": "string",
      "description": "string",
      "customLabel": "string",
      "type": "survey",
      "isReviewRequired": true
    },
    "relationships": {
      "course": {
        "data": {
          "id": "FID001",
          "type": "Course"
        }
      },
      "folder": {
        "data": {
          "id": "FID001",
          "type": "CourseFolder"
        }
      },
      "survey": {
        "data": {
          "id": "FID001",
          "type": "Survey"
        }
      }
    }
  }
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found