Creates a bulk set of Actions. The Payload is a collection of Action Objects to be created.
TABLE OF CONTENTS
- Creates a collection of Actions
- URL Parameters
- Response
- Response Headers
- Definitions
- Expand
- Further Reading
The maximum number of Actions that can be created in a single bulk REST API call is 50.
Creates a collection of Actions
HTTP
POST https://organisation.fluid.work/rest/api/action/bulk
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk?fields=All' \ --header 'Content-Type: application/json' \ --data '[ { "Fields": { "Title": "BULK Create 1", "Description": "Bulk Create 1 - Description", "Status": "Not Started", "TaskType": "Task" } }, { "fields": { "Title": "BULK Create 2", "Description": "Bulk Create 2 - Description", "status": "Not Started", "taskType": "Task" } } ]'
with optional parameters
HTTP
POST https://organisation.fluid.work/rest/api/action/bulk?fields={fields}&$expand={$expand}&version=3.0
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": "BULK Create 1", "Description": "Bulk Create 1 - Description", "Status": "Not Started", "TaskType": "Task" } }, { "fields": { "Title": "BULK Create 2", "Description": "Bulk Create 2 - Description", "status": "Not Started", "taskType": "Task" } } ]'
URL Parameters
Name | In | Required | Type | Description |
fields | query | false | string | Comma-separated list of requested fields |
expand | query | false | string | Expand parameter for Action attributes. Possible options are{"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"} |
version | query | false | string | Version of the API to use. if not set, default latest version will be used. |
Response
Name | Type | Description |
200 OK | Action | successful operation |
400 | string | Bad Request |
401 | string | Not an authorised user, username or token is invalid |
403 | string | Forbidden, user is not permissioned to perform the operation in this particular context |
422 | string | Invalid arguments, request, query or body arguments are invalid |
429 | string | "Too many Requests" see response headers RateLimit-Limit (current rate limit capacity), RateLimit-Remaining (remaining tokens), RateLimit-Reset (time till next refill) |
Response Headers
Name | Type | Description |
RateLimit-Limit | string | Max rate limit of requests allowed |
RateLimit-Remaining | string | Remaining capacity of requests allowed |
RateLimit-Reset | string | Next date time for refresh of capacity |
POST Sample Request
cURL
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/action/bulk' \ --header 'Content-Type: application/json' \ --data '[ { "Fields": { "Title": "BULK Create 1", "Description": "Bulk Create 1 - Description", "Status": "Not Started", "TaskType": "Task" } }, { "fields": { "Title": "BULK Create 2", "Description": "Bulk Create 2 - Description", "status": "Not Started", "taskType": "Task" } } ]'
Sample 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-16T18:19:46.0000000", "description": "Bulk Create 1 - Descrption", "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-16T18:19:46.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": "BULK Create 1" }, "id": 4413, "guid": "f8deb426-bfe1-4663-82f5-8c4c493c4544", "url": "https://organisation.fluid.work/rest/api/action/4413" }, { "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-16T18:19:56.0000000", "description": "Bulk Create 2 - Descrption", "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-16T18:19:56.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": "BULK Create 2" }, "id": 4414, "guid": "93f8a220-098d-4894-ba98-b7c2dec27342", "url": "https://organisation.fluid.work/rest/api/action/4414" }
POST Sample Request with fields=all and expand=all options
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action/bulk?fields=all&expand=all' \ --header 'Content-Type: application/json' \ --data '[ { "Fields": { "Title": "BULK Create 1", "Description": "Bulk Create 1 - Descrption", "Status": "Not Started", "TaskType": "Task" } }, { "fields": { "Title": "BULK Create 2", "Description": "Bulk Create 2 - Descrption", "status": "Not Started", "taskType": "Task" } } ]'
Sample 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": "Task", "createDate": "2024-02-16T18:22:18.0000000", "description": "Bulk Create 1 - Descrption", "descriptionHtml": "Bulk Create 1 - Descrption", "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-16T18:22:18.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-117", "startDate": null, "status": "Not Started", "statusCode": 4, "taskType": "Task", "title": "BULK Create 1", "titleRichText": "BULK Create 1", "titleHtml": "BULK Create 1" }, "id": 4415, "methods": [ { "type": "PermaLink", "httpMethod": "GET", "url": "https://organisation.fluid.work/Action/EditFull/90d486aa-11e9-461d-85a0-f72df83a5e5f" }, { "type": "Update", "httpMethod": "PUT", "url": "https://organisation.fluid.work/rest/api/action/4415", "description": "Update Action", "payload": { "fields": { "description": "<Description>", "title": "<Title>" }, "customProperties": [] } }, { "type": "Delete", "httpMethod": "DELETE", "url": "https://organisation.fluid.work/rest/api/action/4415" } ], "guid": "90d486aa-11e9-461d-85a0-f72df83a5e5f", "url": "https://organisation.fluid.work/rest/api/action/4415" }, { "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": "Task", "createDate": "2024-02-16T18:22:18.0000000", "description": "Bulk Create 2 - Descrption", "descriptionHtml": "Bulk Create 2 - Descrption", "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-16T18:22:18.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-118", "startDate": null, "status": "Not Started", "statusCode": 4, "taskType": "Task", "title": "BULK Create 2", "titleRichText": "BULK Create 2", "titleHtml": "BULK Create 2" }, "id": 4416, "methods": [ { "type": "PermaLink", "httpMethod": "GET", "url": "https://organisation.fluid.work/Action/EditFull/778f7f08-fe2b-4b4f-9e52-49ea2c9319e8" }, { "type": "Update", "httpMethod": "PUT", "url": "https://organisation.fluid.work/rest/api/action/4416", "description": "Update Action", "payload": { "fields": { "description": "<Description>", "title": "<Title>" }, "customProperties": [] } }, { "type": "Delete", "httpMethod": "DELETE", "url": "https://organisation.fluid.work/rest/api/action/4416" } ], "guid": "778f7f08-fe2b-4b4f-9e52-49ea2c9319e8", "url": "https://organisation.fluid.work/rest/api/action/4416" }
Definitions
Name | Description |
id | The Id integer, uniquely identifies this particular Action, can be interchangeable with guid, see below |
guid | The guid string, uniquely identifies this particular Action, can be interchangeable with id, see above |
url | The REST GET Url for this Action |
fields | Map of field and values for the Action |
assignee[] | Describes a list of users this action has been assigned to |
author | Describes the user who authored this Action |
modifiedBy | Describes the user who last modified this Action |
owners[] | Describes a list of users this action is owned by |
Expand
Query parameter "expand=all" will expand all the possible response properties listed below that are associated with this entity. "expand=none" to hide all response properties.
CustomProperties[]
Name | Description |
guid | The guid string, uniquely identifies this particular custom property |
dataType | The data type of the value for this Custom Property. eg string, datetime etc |
isAdminLocked | |
isCatalogType | Custom Property is a Catalog Type and is used as part of taxonomy |
isMultiple | Can contain multiple values |
isSubType | |
key | Unique name key that identifies this Custom Property by name |
required | Flag to indicate this Custom Property requires a valid value |
reportable | Flag to indicate this Custom Property is reportable |
readOnly | Flag to indicate value is read only and cannot be changed |
value | The value of this Custom Property |
Methods[]
Properties returned for requested expanded value set on query param "expand=method", methods are helper properties to other REST verb API endpoints that can be used directly.
Name | Description |
type | The type of action this method performs |
httpMethod | HTTP Request Method verb |
url | The REST URL that can be used with the Http Method verb |
description | Description of what this method performs |
payload | Sample payload related to the HTTP Method verb. This payload is typically the minimal payload required to perform the verb method. |
Attachment[]
Properties returned for requested expanded value set on query param "expand=attachment". Checklist properties that are defined as part of this entity.
Name | Description |
Id | The Id integer, uniquely identifies this particular Attachment |
Guid | The guid string, uniquely identifies this particular Attachment |
Title | Title of this Attachment |
ModifiedDate | Timestamp this Attachment was last modified |
Type | Type of this Attachment |
Status | Status of this Attachment |
Filename | Filename of the attachment |
Url | Url to open/view or download this Attachmemt |
ModifiedBy | User that last modified this Attachment |
Checklist[]
Properties returned for requested expanded value set on query param "expand=checklist". Checklist properties that are defined as part of this entity.
Name | Description |
Title | The title of the checklist item |
Status | The status of the checklist item (true/false) is (checked/un checked) |
Further Reading
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