mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-08 12:27:48 +00:00
46 lines
1.2 KiB
YAML
46 lines
1.2 KiB
YAML
post:
|
|
operationId: syncAttributesForSource
|
|
tags:
|
|
- Sources
|
|
summary: Synchronize single source attributes.
|
|
description: >-
|
|
This end-point performs attribute synchronization for a selected source.
|
|
|
|
A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API.
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
schema:
|
|
type: string
|
|
required: true
|
|
description: The Source id
|
|
responses:
|
|
'202':
|
|
description: A Source Sync job
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../schemas/SourceSyncJob.yaml'
|
|
example:
|
|
{
|
|
"id": "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
|
|
"status": "IN_PROGRESS",
|
|
"payload":
|
|
{
|
|
"type": "SYNCHRONIZE_SOURCE_ATTRIBUTES",
|
|
"dataJson": "{\"sourceId\":\"2c918083746f642c01746f990884012a\"}"
|
|
}
|
|
}
|
|
'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'
|