The below examples illustrate a number of use cases to create a single Actions.
UPDATE REST API Calls REST API update calls to an Action must POST all fields in the body of the payload. Update calls are not DELTA changes. Fluid highly recommends you make a GET call, take the JSON response object, make the relevant update changes you want only on the properties required and POST back as part of the REST API UPDATE or CREATE payload.
TABLE OF CONTENTS
- Create a simple Action
- Create a simple User action fields=all and expand=all options
- Create a Action and assigning to multiple users
- Create a Action on a board workspace.
- Create a Action on a board workspace (Sub Board).
- Create a Action on a board workspace field=all and expand=all options
- Create a Action on a board workspace and assign to multiple users
- Create a Action on a board workspace with Custom Properties
- Create a Action on a board workspace with Attachments (linked)
- Create a Action on a board workspace with Attachments (binary)
Create a simple Action
This example illustrate the how to create a very basic action, a number of the Action properties have been created with default values.
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"title": "Sample Title",
"description": "Sample Description",
"status": "Not Started",
"taskType": "Task"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"businessValue": 0,
"chatCount": 0,
"createDate": "2024-02-16T14:45:22.0000000",
"description": "Sample Description",
"dueDate": null,
"endDate": null,
"impediment": 0,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T14:45:22.0000000",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"priority": "Medium",
"principalGuid": "f1cb6467-0262-4539-9148-7b869defd817",
"ragStatus": "Green",
"startDate": null,
"status": "Not Started",
"statusCode": 4,
"taskType": "Task",
"title": "Sample Title"
},
"id": 4360,
"guid": "46522a95-7668-482a-a484-2952174b2430",
"url": "https://organisation.fluid.work/rest/api/action/4360"
}Create a simple User action fields=all and expand=all options
This example illustrate the how to create a very basic action, a number of the Action properties have been created with default values, query parameter fields=all including all Action properties to be returned, expand=all is including all Action attributes to be returned. Attributes are additional metadata about the Action.
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"priority": "Medium",
"status": "Not Started",
"taskType": "New Feature",
"title": "Sample Title",
"description": "Sample Description"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"businessValue": 0,
"chatCount": 0,
"contentType": "New Feature",
"createDate": "2024-02-16T14:48:57.0000000",
"description": "Sample Description",
"descriptionHtml": "Sample Description",
"dueDate": null,
"endDate": null,
"impediment": 0,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T14:48:57.0000000",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"priority": "Medium",
"principalGuid": "f1cb6467-0262-4539-9148-7b869defd817",
"ragStatus": "Green",
"shortCode": "DB-78",
"startDate": null,
"status": "Not Started",
"statusCode": 4,
"taskType": "Task",
"title": "Sample Title",
"titleRichText": "Sample Title",
"titleHtml": "Sample Title"
},
"id": 4361,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/b0349237-f214-4e30-a669-5a37675bd0c3"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4361",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4361"
}
],
"guid": "b0349237-f214-4e30-a669-5a37675bd0c3",
"url": "https://organisation.fluid.work/rest/api/action/4361"
}Create a Action and assigning to multiple users
To create an Action and assign multiple assignees, as part of the payload, include in the assignee property an array of objects with properties set for username, or id, or guid, or email. Only 1 property is required, per assignee you want to add to this Action.
cURL
curl --user username:patToken --location 'http://oganisation.fluid.work/rest/api/action' \
--header 'Content-Type: application/json' \
--data '{
"fields": {
"assignee": [
{
"userName": "bruce.banner"
},
{
"userName": "adam.jones"
}
],
"description": "Sample Description",
"status": "Not Started",
"taskType": "Task",
"title": "Sample Title"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 595,
"guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
"name": "Adam Jones",
"userName": "adam.jones",
"email": "dump7@fluidbsg.com"
},
{
"id": 598,
"guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
"name": "Bruce Banner",
"userName": "bruce.banner",
"email": "bruce.banner@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"businessValue": 0,
"chatCount": 0,
"createDate": "2024-02-16T16:21:37.0000000",
"description": "Sample Description",
"dueDate": null,
"endDate": null,
"impediment": 0,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T16:21:37.0000000",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"priority": "Medium",
"principalGuid": "f1cb6467-0262-4539-9148-7b869defd817",
"ragStatus": "Green",
"startDate": null,
"status": "In Progress",
"statusCode": 4,
"taskType": "Task",
"title": "Sample Title"
},
"id": 4386,
"guid": "115aed67-4eb3-4716-8189-b04f77b2e36b",
"url": "https://organisation.fluid.work/rest/api/action/4386"
}Create a Action on a board workspace.
To create an Action on a specific board workspace, an additional PrincipalGuid property is required on the POST payload. The PrincipalGuid is the unique key that directly identifies the board. See Create Actions for more details.
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "Sample Title",
"description": "Sample Description"
"status": "Not Started",
"taskType": "Task"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"businessValue": 0,
"chatCount": 0,
"createDate": "2024-02-16T19:20:22.0000000",
"description": "Sample Description - Create Action on a Board",
"dueDate": null,
"endDate": null,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T19:20:22.0000000",
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title - Create Action on a Board"
},
"id": 4432,
"guid": "087bf9a3-ac33-420c-8b2f-efb186b32508",
"url": "https://organisation.fluid.work/rest/api/action/4432"
}Create a Action on a board workspace (Sub Board).
To create an Action on a specific sub board in a board workspace, two additional guids are needed as part of the POST payload, the PrincipalGuid property of the board workspace and the ParentGuid of the sub board. The PrincipalGuid is the unique key that directly identifies the board workspace and the ParentGuid is the unique key that identifies the sub board . See Create Actions for more details.
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "Sample Title",
"description": "Sample Description"
"status": "Not Started",
"taskType": "Task"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"businessValue": 0,
"chatCount": 0,
"createDate": "2024-02-16T19:20:22.0000000",
"description": "Sample Description - Create Action on a Board",
"dueDate": null,
"endDate": null,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T19:20:22.0000000",
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title - Create Action on a Board"
},
"id": 4432,
"guid": "087bf9a3-ac33-420c-8b2f-efb186b32508",
"url": "https://organisation.fluid.work/rest/api/action/4432"
}Create a Action on a board workspace field=all and expand=all options
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data ' {
"fields": {
"priority": "Medium",
"status": "Not Started",
"taskType": "New Feature",
"title": "Sample Title",
"description": "Sample Description"
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"boardGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"boardTitle": "Bulk edit",
"businessValue": 0,
"chatCount": 0,
"contentType": "Process",
"createDate": "2024-02-16T19:20:41.0000000",
"description": "Sample Description - Create Action on a Board",
"descriptionHtml": "Sample Description - Create Action on a Board",
"dueDate": null,
"endDate": null,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T19:20:41.0000000",
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"shortCode": "BE-105",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title - Create Action on a Board",
"titleRichText": "Sample Title - Create Action on a Board",
"titleHtml": "Sample Title - Create Action on a Board"
},
"id": 4433,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/12c2e661-270c-43e1-8d05-1218b5842b6c"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4433",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4433"
}
],
"guid": "12c2e661-270c-43e1-8d05-1218b5842b6c",
"url": "https://organisation.fluid.work/rest/api/action/4433"
}Create a Action on a board workspace and assign to multiple users
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk?fields=all&expand=all' \
--header 'Content-Type: application/json' \
--data '
{
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "Sample Title 1",
"description": "Sample Description 1",
"status": "Not Started",
"taskType": "Task",
"assignee": [
{
"userName": "bruce.banner"
},
{
"userName": "emily.smith"
}
]
}
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 598,
"guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
"name": "Bruce Banner",
"userName": "bruce.banner",
"email": "bruce.banner@fluidbsg.com"
},
{
"id": 593,
"guid": "f8ba0d1c-ae23-4d88-a566-7d071eacdf1e",
"name": "Emily Smith",
"userName": "emily.smith",
"email": "emily@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"boardGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"boardTitle": "Bulk edit",
"businessValue": 0,
"chatCount": 0,
"contentType": "Process",
"createDate": "2024-02-16T23:00:33.0000000",
"description": "Sample Description 1",
"descriptionHtml": "Sample Description 1",
"dueDate": null,
"endDate": null,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T23:00:33.0000000",
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"shortCode": "BE-107",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title 1",
"titleRichText": "Sample Title 1",
"titleHtml": "Sample Title 1"
},
"id": 4442,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/e735d171-d8b8-479b-bc97-1bad99b8ea67"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4442",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4442"
}
],
"guid": "e735d171-d8b8-479b-bc97-1bad99b8ea67",
"url": "https://organisation.fluid.work/rest/api/action/4442"
}Create a Action on a board workspace with Custom Properties
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?fields=All&expand=All' \
--header 'Content-Type: application/json' \
--data '{
"fields": {
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"title": "Sample Title",
"description": "Sample Description",
"status": "Not Started",
"taskType": "Task"
},
"customProperties": [
{
"dataType": "Text",
"key": "custom1",
"value": "Custom Sample 1"
},
{
"dataType": "MultiOption",
"key": "CustomMulti",
"value": "mult2"
},
{
"dataType": "Date",
"key": "CustomDate",
"value": "2023-10-17"
}
]
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 0,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"boardGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"boardTitle": "Bulk edit",
"businessValue": 0,
"chatCount": 0,
"contentType": "Process",
"createDate": "2024-02-16T23:04:54.0000000",
"description": "Sample Description",
"descriptionHtml": "Sample Description",
"dueDate": null,
"endDate": null,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-02-16T23:04:54.0000000",
"principalGuid": "7505a102-93fc-4465-a23b-2eb6303f7f71",
"shortCode": "BE-110",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title",
"titleRichText": "Sample Title",
"titleHtml": "Sample Title"
},
"customProperties": [
{
"guid": "bf98c357-c90e-4d0b-9d4e-fd5c30a90f6b",
"dataType": "Text",
"isAdminLocked": false,
"isCatalogType": false,
"isMultiple": false,
"isSubType": false,
"key": "custom1",
"required": false,
"reportable": false,
"readOnly": false,
"value": "Custom Sample 1"
},
{
"guid": "7f576c5c-058e-4448-8300-7eb3dd7396a7",
"dataType": "MultiOption",
"isAdminLocked": false,
"isCatalogType": false,
"isMultiple": false,
"isSubType": false,
"key": "CustomMulti",
"required": false,
"reportable": false,
"readOnly": false,
"value": "mult2"
},
{
"guid": "8d82f380-a32f-4649-a38b-79f067da4aea",
"dataType": "Date",
"isAdminLocked": false,
"isCatalogType": false,
"isMultiple": false,
"isSubType": false,
"key": "CustomDate",
"required": false,
"reportable": false,
"readOnly": false,
"value": "2023-10-17"
}
],
"id": 4445,
"methods": [
{
"type": "PermaLink",
"httpMethod": "GET",
"url": "https://organisation.fluid.work/Action/EditFull/df8a5ccf-8bed-4cf8-9c7d-89f7c2603237"
},
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/action/4445",
"description": "Update Action",
"payload": {
"fields": {
"description": "<Description>",
"title": "<Title>"
},
"customProperties": []
}
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/action/4445"
}
],
"guid": "df8a5ccf-8bed-4cf8-9c7d-89f7c2603237",
"url": "https://organisation.fluid.work/rest/api/action/4445"
}Create a Action on a board workspace with Attachments (linked)
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?fields=All&expand=All' \
--header 'Content-Type: application/json' \
--data '{
"fields": {
"principalGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"title": "Sample Title",
"description": "Sample Description",
"status": "Not Started",
"taskType": "Task"
},
"attachments": [
{
"title": "Sample attachment document link",
"url": "https://organisation.sharepoint.com/documents/123456"
}
]
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 1,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"boardGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"boardTitle": "Agile T1",
"businessValue": 0,
"chatCount": 0,
"contentType": "Process",
"createDate": "2024-04-23T17:25:34.0000000",
"description": "Sample Description",
"descriptionHtml": "Sample Description",
"dueDate": null,
"endDate": null,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-04-23T17:25:34.0000000",
"parentGuid": "3d3a4acf-193e-424b-a61d-856d83728ba3",
"principalGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"shortCode": "AT-103",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title",
"titleRichText": "Sample Title",
"titleHtml": "Sample Title"
},
"attachments": [
{
"id": 116,
"guid": "d41c55aa-2b2a-45c3-851e-f9f1ee380a8b",
"type": "Miscellaneous",
"status": "Draft",
"fileName": "https://organisation.sharepoint.com/documents/123456",
"title": "Sample attachment document link",
"modifiedDate": "2024-04-23T17:25:34.0000000",
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"url": "https://organisation.sharepoint.com/documents/123456"
}
],
"id": 4618,
"guid": "f43b5a3c-a1e1-4453-8884-da93d13eaafd",
"url": "https://organisation.fluid.work/rest/api/action/4618"
}Create a Action on a board workspace with Attachments (binary)
cURL
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?fields=All&expand=All' \
--header 'Content-Type: application/json' \
--data '{
"fields": {
"principalGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"title": "Sample Title",
"description": "Sample Description",
"status": "Not Started",
"taskType": "Task"
},
"attachments": [
{
"fileName": "sample.docx",
"title": "Sample attachment document",
"data": "<BASE64 Encoded String>"
}
]
}'Response
Status code: 200
JSON
{
"fields": {
"assignee": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"attachmentCount": 1,
"author": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"boardCategory": 0,
"boardId": 0,
"boardGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"boardTitle": "Agile T1",
"businessValue": 0,
"chatCount": 0,
"contentType": "Process",
"createDate": "2024-04-24T11:20:56.0000000",
"description": "Sample Description",
"descriptionHtml": "Sample Description",
"dueDate": null,
"endDate": null,
"isClosed": false,
"isCalculated": false,
"isOwner": true,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2024-04-24T11:20:56.0000000",
"parentGuid": "3d3a4acf-193e-424b-a61d-856d83728ba3",
"principalGuid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"shortCode": "AT-108",
"startDate": null,
"status": "Not Started",
"statusCode": 1,
"taskType": "Task",
"title": "Sample Title",
"titleRichText": "Sample Title",
"titleHtml": "Sample Title"
},
"attachments": [
{
"id": 122,
"guid": "cb69c061-f381-444d-a0e9-04fb508d3c60",
"type": "Miscellaneous",
"status": "Draft",
"fileName": "sample.docx",
"title": "sample",
"modifiedDate": "2024-04-24T11:20:59.0000000",
"url": "https://organisation.fluid.work/Document/Download?id=cb69c061-f381-444d-a0e9-04fb508d3c60"
}
],
"id": 4623,
"guid": "e2b4daf6-e196-416d-8af5-7f0a2233b901",
"url": "https://organisation.fluid.work/rest/api/action/4623"
}Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article