action biapi_post_users_id_user_connections_id_connection_sources_id_source {
label: "\""
description: "This endpoint is used to enable a source or force a synchronization on it.
"
provider: biapi
method: POST
path: "/users/{id_user}/connections/{id_connection}/sources/{id_source}"
encoding: json
input: {
type: "object"
properties: {
background: {
type: "boolean"
}
expand: {
type: "string"
}
id_connection: {
type: "integer"
}
id_source: {
type: "integer"
}
id_user: {
type: "string"
}
}
required: ["id_connection", "id_source", "id_user"]
additionalProperties: false
}
output: {
type: "object"
required: ["created", "id", "id_connection", "id_connector_source", "name"]
properties: {
access_expire: {
type: "string"
format: "date-time"
description: "Expiration date of the access"
}
created: {
type: "string"
format: "date-time"
description: "Creation date of the connection source"
}
disabled: {
type: "string"
format: "date-time"
description: "This source is not used to synchronize the connection"
}
expire: {
type: "string"
format: "date-time"
description: "Expiration of the connection source. Used to purge the connection in case completion was not finished"
}
id: {
type: "integer"
description: "ID of connection"
}
id_connection: {
type: "integer"
description: "ID of the related connection"
}
id_connector_source: {
type: "integer"
description: "ID of the related connector source"
}
last_update: {
type: "string"
format: "date-time"
description: "Last successful update"
}
name: {
type: "string"
description: "Name of the connection source"
}
next_try: {
type: "string"
format: "date-time"
description: "Date of next synchronization"
}
state: {
type: "string"
description: "If the last update has failed, the state code"
}
}
}
}