mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
02db373b78
* IDNWAIMEA-11000: Migrate API docs from /beta/campaigns/<id>/reassign to /v3/campaigns/campaigns/<id>/reassign * IDNWAIMEA-11000: address validator checks * IDNWAIMEA-11000: add list of ReassignmentTrailDTO * IDNWAIMEA-11000: add description to ReassignmentTrailDTOList * IDNWAIMEA-11000: add description to ReassignmentTrailDTOList * IDNWAIMEA-11000: add description to ReassignmentTrailDTOList' by github action: 5338525049
51 lines
1.4 KiB
YAML
51 lines
1.4 KiB
YAML
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the certification task.
|
|
example: 2c918086719eec070171a7e3355a360a
|
|
type:
|
|
type: string
|
|
description: The type of the certification task. More values may be added in the future.
|
|
enum:
|
|
- REASSIGN
|
|
- ADMIN_REASSIGN
|
|
- COMPLETE_CERTIFICATION
|
|
- FINISH_CERTIFICATION
|
|
- COMPLETE_CAMPAIGN
|
|
- ACTIVATE_CAMPAIGN
|
|
- CAMPAIGN_CREATE
|
|
- CAMPAIGN_DELETE
|
|
example: ADMIN_REASSIGN
|
|
targetType:
|
|
type: string
|
|
description: The type of item that is being operated on by this task whose ID is stored in the targetId field.
|
|
enum:
|
|
- CERTIFICATION
|
|
- CAMPAIGN
|
|
example: CAMPAIGN
|
|
targetId:
|
|
type: string
|
|
description: The ID of the item being operated on by this task.
|
|
example: 2c918086719eec070171a7e3355a834c
|
|
status:
|
|
type: string
|
|
description: The status of the task.
|
|
enum:
|
|
- QUEUED
|
|
- IN_PROGRESS
|
|
- SUCCESS
|
|
- ERROR
|
|
example: QUEUED
|
|
errors:
|
|
$ref: './ErrorMessageDtoList.yaml'
|
|
description: A list of errors that have been encountered by the task.
|
|
reassignmentTrailDTOs:
|
|
$ref: './ReassignmentTrailDTOList.yaml'
|
|
description: Reassignment trails that lead to self certification identity
|
|
created:
|
|
type: string
|
|
description: The date and time on which this task was created.
|
|
format: date-time
|
|
example: '2020-09-24T18:10:47.693Z'
|