Transfers
Get Transfer
GET | {{baseUrl}}/orchestrator/api/apps/<app_id>/transfers/<transfer_id>/ | Gets the Transfer by |
---|
URL Parameters
Name | Description | Example |
---|---|---|
| The App uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
| The Transfer uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
Response (Success)
HTTP/1.1 200 OK
Returns the Transfer object.
Example
{
"id": "464631a5-a3fb-4e92-9ff1-20bdf2c3ad48",
"component_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d.my_transfer12.Transfer.my_app3.vk_org",
"attached_data": [
{
"key": "intent",
"value": "Balance"
},
{
"key": "authenticated",
"value": "true"
},
{
"key": "region",
"value": "California"
}
],
"created_at": "2021-03-24T12:25:39.889640Z",
"updated_at": "2021-03-24T12:25:39.889688Z",
"user_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d",
"group": "vk_org",
"name": "my_transfer12",
"target": "00012345",
"reason": "Route out intent",
"app": "ddc764ff-0e2a-4af0-a02e-6dd0b28d11b8"
}
Response (Failed)
HTTP/1.1 404 NOT_FOUND
Create Transfer
POST | {{baseUrl}}/orchestrator/api/apps/<app_id>/transfers/ | Creates a Transfer. |
---|
URL Parameters
Name | Description | Example |
---|---|---|
| The App uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
Request Payload
A Transfer object.
Name | Type | Default | Description | Required |
---|---|---|---|---|
| string | - | Transfer's name. | yes |
| string | - | Transfer's target. | yes |
| string | - | Transfer's transfer reason. | no |
| array[Attached Data] | - | Transfer's attached data. | yes (the field must exist in the payload, but the list can be empty) |
Example
{
"id": "464631a5-a3fb-4e92-9ff1-20bdf2c3ad48",
"component_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d.my_transfer12.Transfer.my_app3.vk_org",
"attached_data": [
{
"key": "intent",
"value": "Balance"
},
{
"key": "authenticated",
"value": "true"
},
{
"key": "region",
"value": "California"
}
],
"created_at": "2021-03-24T12:25:39.889640Z",
"updated_at": "2021-03-24T12:25:39.889688Z",
"user_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d",
"group": "vk_org",
"name": "my_transfer12",
"target": "00012345",
"reason": "Route out intent",
"app": "ddc764ff-0e2a-4af0-a02e-6dd0b28d11b8"
}
Response (Success)
HTTP/1.1 201 CREATED
The updated Transfer object.
Example
{
"id": "464631a5-a3fb-4e92-9ff1-20bdf2c3ad48",
"component_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d.my_transfer12.Transfer.my_app3.vk_org",
"attached_data": [
{
"key": "intent",
"value": "Balance"
},
{
"key": "authenticated",
"value": "true"
},
{
"key": "region",
"value": "California"
}
],
"created_at": "2021-03-24T12:25:39.889640Z",
"updated_at": "2021-03-24T12:25:39.889688Z",
"user_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d",
"group": "vk_org",
"name": "my_transfer12",
"target": "00012345",
"reason": "Route out intent",
"app": "ddc764ff-0e2a-4af0-a02e-6dd0b28d11b8"
}
Response (Failed)
HTTP/1.1 400 BAD_REQUEST
The failed status 400 BAD_REQUEST
can be returned in the following cases:
if the transfer name contains invalid characters (acceptable characters are only alphanumeric [a-Z0-9] and the underscore character '_'):
Example
JSON{ "name": [ "Invalid transfer name. Transfer name must contain only alphanumeric characters and the underscore character." ] }
if the unique transfer name per application constraint is violated:
Example
JSON[ { "name": "Transfer with name and app already exists." } ]
if the group access privileges constraint is violated (the application is under a group to which the user does not have access privileges):
Example
JSON[ { "name": "Application '<app_id>' is under the group '<group_name>' to which you do not have access privileges" } ]
Update Transfer
PUT | {{baseUrl}}/orchestrator/api/apps/<app_id>/transfers/<transfer_id>/ | Updates the Transfer. |
---|
URL Parameters
Name | Description | Example |
---|---|---|
| The App uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
| The Transfer uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
Request Payload
A Transfer object.
Name | Type | Description | Required |
---|---|---|---|
| string | Transfer's target. | yes |
| string | Transfer's transfer reason. | no |
| array[Attached Data] | Transfer's attached data. | yes (the field must exist in the payload, but the list can be empty) |
Example
{
"id": "464631a5-a3fb-4e92-9ff1-20bdf2c3ad48",
"component_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d.my_transfer12.Transfer.my_app3.vk_org",
"attached_data": [
{
"key": "intent",
"value": "Balance"
},
{
"key": "authenticated",
"value": "true"
},
{
"key": "region",
"value": "California"
}
],
"created_at": "2021-03-24T12:25:39.889640Z",
"updated_at": "2021-03-24T12:25:39.889688Z",
"user_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d",
"group": "vk_org",
"name": "my_transfer12",
"target": "00012345",
"reason": "Route out intent",
"app": "ddc764ff-0e2a-4af0-a02e-6dd0b28d11b8"
}
Response (Success)
HTTP/1.1 200 OK
Delete Transfer
DELETE | {{baseUrl}}/orchestrator/api/apps/<app_id>/transfers/<transfer_id>/ | Deletes the Transfer. |
---|
URL Parameters
Name | Description | Example |
---|---|---|
| The Application uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
| The Transfer uuid. | '930157b3-671c-4a81-a5d5-315fa63c6172' |
Response (Success)
HTTP/1.1 204 NO_CONTENT
Response (Failed)
HTTP/1.1 404 NOT_FOUND
Response (Failed)
HTTP/1.1 409 CONFLICT
The failed status 409 CONFLICT
can be returned if Transfer is in use by other App/Flow:
Example
{
"detail": "Cannot delete the Transfer, because it is used by these objects: test_app(app),test_flow(flow)"
}
Models
Transfer
Name | Type | Description |
---|---|---|
| string | The Transfer's name. |
| string | The Transfer's target. |
| string | The Transfer's transfer reason. |
| array[Attached Data] | The Transfer's attached data. |
Transfer.Attached Data
Name | Type | Description |
---|---|---|
| string | The attached data name. |
| string | The attached data value. |
Example
{
"id": "464631a5-a3fb-4e92-9ff1-20bdf2c3ad48",
"component_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d.my_transfer12.Transfer.my_app3.vk_org",
"attached_data": [
{
"key": "intent",
"value": "Balance"
},
{
"key": "authenticated",
"value": "true"
},
{
"key": "region",
"value": "California"
}
],
"created_at": "2021-03-24T12:25:39.889640Z",
"updated_at": "2021-03-24T12:25:39.889688Z",
"user_id": "960d06c4-bdc9-4673-aef1-fbdf4ca1ae6d",
"group": "vk_org",
"name": "my_transfer12",
"target": "00012345",
"reason": "Route out intent",
"app": "ddc764ff-0e2a-4af0-a02e-6dd0b28d11b8"
}