mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-10 12:27:48 +00:00
9269e86172
* added new oauth2 flow and description * renamed authentication to make more sense' by github action: 5967546682
127 lines
3.9 KiB
YAML
127 lines
3.9 KiB
YAML
get:
|
|
operationId: getNonEmployeeSourceSchemaAttributes
|
|
security:
|
|
- UserContextAuth: []
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: List Schema Attributes Non-Employee Source
|
|
description: This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8
|
|
mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can
|
|
add up to 10 custom attributes. This interface returns all the mandatory attributes followed by
|
|
any custom attributes. At most, a total of 18 attributes will be returned.
|
|
parameters:
|
|
- in: path
|
|
example: "2c918085842e69ae018432d22ccb212f"
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The Source id
|
|
responses:
|
|
'200':
|
|
description: A list of Schema Attributes
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
example: [{
|
|
"type": "TEXT",
|
|
"label": "string",
|
|
"technicalName": "string",
|
|
"helpText": "string",
|
|
"placeholder": "string",
|
|
"required": true
|
|
}]
|
|
items:
|
|
$ref: '../schemas/NonEmployeeSchemaAttribute.yaml'
|
|
maxItems: 18
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'404':
|
|
$ref: '../../v3/responses/404.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
post:
|
|
operationId: createNonEmployeeSourceSchemaAttributes
|
|
security:
|
|
- UserContextAuth: [idn:nelm:manage]
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Create Non-Employee Source Schema Attribute
|
|
description: >-
|
|
This API creates a new schema attribute for Non-Employee Source. The schema technical name must be
|
|
unique in the source. Attempts to create a schema attribute with an existing name will result in a
|
|
"400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts
|
|
to create more than 10 will result in a "400.1.4 Limit violation" response.
|
|
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
example: 2c91808b6ef1d43e016efba0ce470904
|
|
description: The Source id
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/NonEmployeeSchemaAttributeBody.yaml'
|
|
responses:
|
|
'200':
|
|
description: >-
|
|
Schema Attribute created.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/NonEmployeeSchemaAttribute.yaml'
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|
|
delete:
|
|
operationId: deleteNonEmployeeSourceSchemaAttributes
|
|
security:
|
|
- UserContextAuth: [idn:nelm:manage]
|
|
tags:
|
|
- Non-Employee Lifecycle Management
|
|
summary: Delete all custom schema attributes
|
|
description: >-
|
|
This end-point deletes all custom schema attributes for a non-employee source.
|
|
|
|
parameters:
|
|
- in: path
|
|
name: sourceId
|
|
schema:
|
|
type: string
|
|
required: true
|
|
example: 2c91808b6ef1d43e016efba0ce470904
|
|
description: The Source id
|
|
responses:
|
|
'204':
|
|
$ref: '../../v3/responses/204.yaml'
|
|
description: All custon Schema Attributes were successfully deleted.
|
|
'400':
|
|
$ref: '../../v3/responses/400.yaml'
|
|
'401':
|
|
$ref: '../../v3/responses/401.yaml'
|
|
'403':
|
|
$ref: '../../v3/responses/403.yaml'
|
|
'429':
|
|
$ref: '../../v3/responses/429.yaml'
|
|
'500':
|
|
$ref: '../../v3/responses/500.yaml'
|