AssignmentEventGroup

Groups keep the work steps of a large assignment organized: an AssignmentEvent belongs to at most one group, by its groupUuid. Removing a group removes its events.

Operations

GET/v2/assignment-event-groups/specGET/v2/assignment-event-groupsPOST/v2/assignment-event-groupsGET/v2/assignment-event-groups/{assignmentEventGroupUuid}DELETE/v2/assignment-event-groups/{assignmentEventGroupUuid}PATCH/v2/assignment-event-groups/{assignmentEventGroupUuid}

---

OpenAPI Spec

GET

/v2/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

/v2/assignment-event-groups/spec

Playground

Samples

---

List AssignmentEventGroups

GET

/v2/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

uuid

name

typeUuid

assignmentUuid

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"note": "string",

  

  

  

"order": 0,

  

  

  

"externalId": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string",

  

  

  

"typeUuid": "string",

  

  

  

"assignmentUuid": "string"

  

  

}

  

]

}

GET

/v2/assignment-event-groups

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

name

typeUuid

assignmentUuid

externalId

createdAt

updatedAt

Samples

---

Create a new AssignmentEventGroup

POST

/v2/assignment-event-groups

Create a new AssignmentEventGroup

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"name": null,

  

"note": null,

  

"order": 1,

  

"externalId": null,

  

"typeUuid": "string",

  

"assignmentUuid": "string"

}

Responses

AssignmentEventGroup found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"note": "string",

  

"order": 0,

  

"externalId": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"typeUuid": "string",

  

"assignmentUuid": "string"

}

POST

/v2/assignment-event-groups

Playground

Server

Authorization

apiKey

Body

Samples

---

Get an AssignmentEventGroup

GET

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Get an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupUuid*

Type

string

Required

Format

"uuid"

Responses

AssignmentEventGroup found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"note": "string",

  

"order": 0,

  

"externalId": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"typeUuid": "string",

  

"assignmentUuid": "string"

}

GET

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupUuid*

Samples

---

Delete an AssignmentEventGroup

DELETE

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Delete an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupUuid*

Type

string

Required

Format

"uuid"

Responses

Successfully removed

DELETE

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupUuid*

Samples

---

Update an AssignmentEventGroup

PATCH

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Update an AssignmentEventGroup by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

assignmentEventGroupUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"note": "string",

  

"order": 0,

  

"externalId": "string"

}

Responses

AssignmentEventGroup found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"note": "string",

  

"order": 0,

  

"externalId": "string",

  

"createdAt": "string",

  

"updatedAt": "string",

  

"typeUuid": "string",

  

"assignmentUuid": "string"

}

PATCH

/v2/assignment-event-groups/{assignmentEventGroupUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

assignmentEventGroupUuid*

Body

Samples

---