AssignmentEventGroup

If an assignment has many assignmentEvents it could make sense to add assignmentEventGroups to keep your assignment organized.

Operations

GET/v1/assignment-event-groups/specGET/v1/assignment-event-groupsPOST/v1/assignment-event-groupsGET/v1/assignment-event-groups/{assignmentEventGroupId}DELETE/v1/assignment-event-groups/{assignmentEventGroupId}PATCH/v1/assignment-event-groups/{assignmentEventGroupId}

---

OpenAPI Spec

GET

/v1/assignment-event-groups/spec

Get OpenAPI 3.1.0 spec for AssignmentEventGroup API

Responses

Returns OpenAPI 3.1.0 spec for AssignmentEventGroup API

Content-Type

application/json

{

}

GET

/v1/assignment-event-groups/spec

Playground

Samples

---

List AssignmentEventGroups

GET

/v1/assignment-event-groups

List AssignmentEventGroups

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

id

name

typeId

assignmentId

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"note": "string",

"order": 0,

"typeId": 0,

"assignmentId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/assignment-event-groups

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

id

name

typeId

assignmentId

externalId

createdAt

updatedAt

Samples

---

Create a new AssignmentEventGroup

POST

/v1/assignment-event-groups

Create a new AssignmentEventGroup

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

"name": null,

"note": null,

"order": 1,

"typeId": 0,

"assignmentId": 0,

"externalId": null

}

Responses

AssignmentEventGroup found

Content-Type

application/json

{

"id": 0,

"name": "string",

"note": "string",

"order": 0,

"typeId": 0,

"assignmentId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

POST

/v1/assignment-event-groups

Playground

Server

Authorization

apiKey

Body

Samples

---

Get an AssignmentEventGroup

GET

/v1/assignment-event-groups/{assignmentEventGroupId}

Get an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupId*

Type

integer

Required

Format

"int32"

Responses

AssignmentEventGroup found

Content-Type

application/json

{

"id": 0,

"name": "string",

"note": "string",

"order": 0,

"typeId": 0,

"assignmentId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/assignment-event-groups/{assignmentEventGroupId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupId*

Samples

---

Delete an AssignmentEventGroup

DELETE

/v1/assignment-event-groups/{assignmentEventGroupId}

Delete an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupId*

Type

integer

Required

Format

"int32"

Responses

Successfully removed

DELETE

/v1/assignment-event-groups/{assignmentEventGroupId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupId*

Samples

---

Update an AssignmentEventGroup

PATCH

/v1/assignment-event-groups/{assignmentEventGroupId}

Update an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupId*

Type

integer

Required

Format

"int32"

Request Body

application/json

{

"name": "string",

"note": "string",

"order": 0,

"typeId": 0,

"externalId": "string"

}

Responses

AssignmentEventGroup found

Content-Type

application/json

{

"id": 0,

"name": "string",

"note": "string",

"order": 0,

"typeId": 0,

"assignmentId": 0,

"externalId": "string",

"createdAt": "string",

"updatedAt": "string"

}

PATCH

/v1/assignment-event-groups/{assignmentEventGroupId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupId*

Body

Samples

---