Files
developer.sailpoint.com/static/api-specs/idn/beta/paths/task-definition.yaml
2022-09-29 21:59:22 +00:00

70 lines
1.8 KiB
YAML

#
# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved.
#
get:
tags:
- Task Management
summary: Retrieves a task definition summary by task definition ID
description: Get a specified TaskDefinitionSummary.
operationId: getTaskDefinitionSummary
parameters:
- name: id
in: path
description: ID of the TaskDefinition to get a summary for
required: true
style: simple
explode: false
schema:
type: string
example: taskDefId
responses:
"200":
description: TaskDefinitionSummary with the given task definition ID
content:
application/json:
schema:
$ref: '../schemas/TaskDefinitionSummary.yaml'
"403":
$ref: '../../v3/responses/403.yaml'
"404":
$ref: '../../v3/responses/404.yaml'
security:
- oauth2: [idn:task-definition:read]
patch:
tags:
- Task Management
summary: Patch a specified TaskDefinition.
description: Update an existing TaskDefinition using PATCH.
operationId: patchTaskDefinition
parameters:
- name: id
in: path
description: ID of the TaskDefinition to patch
required: true
style: simple
explode: false
schema:
type: string
example: taskDefId
requestBody:
content:
application/json-patch+json:
schema:
$ref: '../schemas/JsonPatch.yaml'
required: true
responses:
"200":
description: Responds with the TaskDefinition as updated.
content:
application/json:
schema:
$ref: '../schemas/TaskDefinitionSummary.yaml'
"400":
$ref: '../../v3/responses/400.yaml'
"403":
$ref: '../../v3/responses/403.yaml'
"404":
$ref: '../../v3/responses/404.yaml'
security:
- oauth2: [idn:task-definition:write]