Boomi MFT - AFT Management API Reference (v1) - FlowEndpointTags
UpdatedDownload OpenAPI Specification: Download
For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.
Retrieves a specific flow endpoint tag by ID
Requires flow endpoint tag read permission. Returns the tag associated with the supplied identifier.
Authorizations:
path Parameters
| flowEndpointTagId required | integer <int32> Unique identifier of the flow endpoint tag. |
Responses
Response Schema:
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Response samples
- 200
- 403
- 500
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Deletes a specific flow endpoint tag
Requires flow endpoint tag read and delete permissions. Removes only the selected tag.
Authorizations:
path Parameters
| flowEndpointTagId required | integer <int32> Unique identifier of the flow endpoint tag to delete. |
Responses
Response Schema:
object (thruStatus) | |
| data | any or null |
Response samples
- 200
- 403
- 500
{- "status": {
- "status": 0,
- "severity": 0,
- "module": "string",
- "method": "string",
- "message": "string"
}, - "data": null
}Retrieves all tags for a specific flow endpoint
Requires flow endpoint tag read permission. Returns the tags assigned to the selected flow endpoint.
Authorizations:
query Parameters
| flowEndpointId required | integer <int32> Unique identifier of the flow endpoint whose tags are requested. |
Responses
Response Schema:
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Response samples
- 200
- 403
- 500
[- {
- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}
]Creates a new tag for a flow endpoint
Requires flow endpoint tag read and create permissions. Duplicate names or exceeding the tag limit return a validation error.
Authorizations:
Request Body schema:
Tag name, value, and the flow endpoint to associate it with.
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Responses
Response Schema:
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Request samples
- Payload
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 403
- 500
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Updates an existing tag for a flow endpoint
Requires flow endpoint tag read, create, and update permissions. Duplicate names or exceeding the tag limit return a validation error.
Authorizations:
Request Body schema:
Complete updated tag, including its identifier and flow endpoint.
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Responses
Response Schema:
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Request samples
- Payload
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 403
- 500
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Saves a flow endpoint tag (creates new or updates existing based on ID)
Requires flow endpoint tag read, create, and update permissions. Returns the saved tag; duplicate names or exceeding the tag limit return a validation error.
Authorizations:
Request Body schema:
Tag to save; a positive identifier updates an existing tag, otherwise a new tag is created.
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Responses
Response Schema:
| id | integer <int32> |
| flowEndpointId | integer <int32> |
| name | string or null |
| value | string or null |
| createdBy | string or null |
| createdDate | string or null <date-time> |
| updatedBy | string or null |
| updatedDate | string or null <date-time> |
| deletedBy | string or null |
| deletedDate | string or null <date-time> |
Request samples
- Payload
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Response samples
- 200
- 400
- 403
- 500
{- "id": 0,
- "flowEndpointId": 0,
- "name": "string",
- "value": "string",
- "createdBy": "string",
- "createdDate": "2019-08-24T14:15:22Z",
- "updatedBy": "string",
- "updatedDate": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "deletedDate": "2019-08-24T14:15:22Z"
}Deletes all tags for a specific flow endpoint
Requires flow endpoint tag read and delete permissions. Removes all tags assigned to the selected flow endpoint.
Authorizations:
query Parameters
| flowEndpointId required | integer <int32> Unique identifier of the flow endpoint whose tags will be removed. |
Responses
Response Schema:
object (thruStatus) | |
| data | any or null |
Response samples
- 200
- 403
- 500
{- "status": {
- "status": 0,
- "severity": 0,
- "module": "string",
- "method": "string",
- "message": "string"
}, - "data": null
}