Deletes an existing single Action.
TABLE OF CONTENTS
Deletes in Fluid are non permanent, Actions that are deleted are internally marked as archived and are typically no longer included as part of the live data set that is used within Fluid.
Deletes an Action
HTTP
DELETE https://organisation.fluid.work/rest/api/action/{id}cURL
curl --user username:patToken --location --request DELETE 'http://organisation.fluid.work/rest/api/action/4360' \ --header 'Content-Type: application/json' \ }'
with optional parameters
HTTP
DELETE https://organisation.fluid.work/rest/api/action/?fields={fields}&$expand={$expand}&version=3.0cURL
curl --user username:patToken --location --request PUT 'http://organisation.fluid.work/rest/api/action/4360?fields=all&expand=all' \ --header 'Content-Type: application/json' \ }'
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"
}URL Parameters
| Name | In | Required | Type | Description |
| fields | query | false | string | Comma-separated list of requested fields to return in the response |
| 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 |
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 |
Assignee[]
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
Author
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
ModifiedBy
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
Owners[]
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
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. |
Related[]
Properties returned for requested expanded value set on query param "expand=related", related are other entities that share a relationship with this entity, this can be a parent, sibling or child relationship
| Name | Description |
| Parent | Parent related item to this Action |
| From | This Action was related from this Entity |
| FollowOn[] | Array of FollowOn entities related to this Action |
| Children[] | Array of Children entities related to this Action |
| Project[] | Array of Project entities related to this Action |
| Catalog[] | Array of Catalog entities related to this Action |
FollowOn[]
| 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 |
| Title | Title of this Action |
| Name | Name if this Action |
| CreatedDate | Timestamp this Action was created |
| ModifiedDate | Timestamp this Action was last modified |
| Type | Type of this Action |
| Status | Status of this Action |
| Description | Description of this Action |
| PercentageComplete | Was percentage of this Action has been completed |
| Methods[] | Array of REST API Methods that this Action can perform |
| ExternalReference | If this Action has a reference to an external integration or system, the external reference id is displayed here |
| ReferenceId | Fluid internal reference identifier |
| Principal | The principal container for this Action |
| AssignedTo | User that has been assigned this Action |
| RagStatus | RAG status of this Action if appropriate |
| StartDate | Start timestamp of this Action |
| DueDate | Due timestamp of this Action |
| Owner | Owner of this Action |
| Priority | Priority of this Action |
| ModifiedBy | User that last modified this Action |
| ParentGuid | Parent guid identifier for this Action |
| AttachmentCount | Number of attachments associated with this Action |
| ContentType | The content type of this Action |
Children[]
| 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 |
| Title | Title of this Action |
| Name | Name if this Action |
| CreatedDate | Timestamp this Action was created |
| ModifiedDate | Timestamp this Action was last modified |
| Type | Type of this Action |
| Status | Status of this Action |
| Description | Description of this Action |
| PercentageComplete | Was percentage of this Action has been completed |
| Methods[] | Array of REST API Methods that this Action can perform |
| ExternalReference | If this Action has a reference to an external integration or system, the external reference id is displayed here |
| ReferenceId | Fluid internal reference identifier |
| Principal | The principal container for this Action |
| AssignedTo | User that has been assigned this Action |
| RagStatus | RAG status of this Action if appropriate |
| StartDate | Start timestamp of this Action |
| DueDate | Due timestamp of this Action |
| Owner | Owner of this Action |
| Priority | Priority of this Action |
| ModifiedBy | User that last modified this Action |
| ParentGuid | Parent guid identifier for this Action |
| AttachmentCount | Number of attachments associated with this Action |
| ContentType | The content type of this Action |
Project[]
| Name | Description |
| Id | The Id integer, uniquely identifies this particular Project, can be interchangeable with guid, see below |
| Guid | The guid string, uniquely identifies this particular Project, can be interchangeable with id, see above |
| Category | The Category this Project aligns to |
| ProjectManager | The user assigned as the Project Manager for this Project |
| Description | Description of this Project |
| ExternalReference | External Reference identifier for this Project |
| Name | Name if this Project |
| Type | Type of this Project |
| Status | Status of this Project |
| Owner | Owner of this Project |
| ParentGuid | Parent guid identifier for this Action |
Catalog[]
| Name | Description |
| Id | The Id integer, uniquely identifies this particular Catalog, can be interchangeable with guid, see below |
| Guid | The guid string, uniquely identifies this particular Action, can be interchangeable with id, see above |
| Name | Name if this Catalog |
| ReferenceId | Reference id of this Catalog |
| CatalogTypeGuid | Unique guid that represents the type to which this Catalog is for |
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 |
Integration[]
Properties returned for requested expanded value set on query param "expand=integration" or "expand=integration,related" or "expand=integration,related,subtask" . Integration details as defined for this entity, can be used with "related" and/or "subtask", so show details for related and/or subtask integrated items in the the 3rd party application
| Name | Description |
| Id | The Id integer, uniquely identifies this particular Integrated item, can be interchangeable with guid, see below |
| Guid | The guid string, uniquely identifies this particular Integrated item, can be interchangeable with id, see above |
| Title | Title of this Integrated item |
| Name | Name if this Integrated item |
| CreatedDate | Timestamp this Integrated item was created |
| ModifiedDate | Timestamp this Integrated item was last modified |
| Type | Type of this Integrated item |
| Status | Status name of this Integrated item |
| StatusCode | Status Code as it is resolved into Fluid Statuses |
| Description | Description of this Integrated item |
| PercentageComplete | Was percentage of this Integrated item has been completed |
| ExternalReference | The unique external reference id of the external system |
| ReferenceId | Fluid internal reference identifier |
| Principal | The principal container for this Integrated item |
| AssignedTo | User that has been assigned this Integrated item |
| StartDate | Start timestamp of this Integrated itemif mapped and any |
| DueDate | Due timestamp of this Integrated itemif mapped and any |
| EndDate | End timestamp of this Integrated itemif mapped and any |
| Owner | Owner of this Integrated item |
| Priority | Priority of this Integrated itemif mapped and any |
| ModifiedBy | User that last modified this Integrated item |
| ParentGuid | Parent guid identifier for this Integrated item |
| AttachmentCount | Number of attachments associated with this Integrated item |
| NotStartedCount | Total number of subtasks for this Integrated item that are in a NotStarted status (NotStarted statuses are defined as per integrated config) |
| InProgressCount | Total number of subtasks for this Integrated item that are in a In Progress status (In Progress statuses are defined as per integrated config) |
| CompletedCount | Total number of subtasks for this Integrated item that are in a Completed status (Completed statuses are defined as per integrated config) |
| NotStartedPercentage | Not started as a percentage (%) |
| InProgressPercentage | In Progress as a percentage (%) |
| CompletedPercentage | Completed as a percentage (%) |
| Points | Points allocated to this item if mapped and any |
| BusinessValue | BusinessValue allocated to this item if mapped and any |
| LastSync | Timestamp this item was last synced into Fluid |
| ExternalStatus | The status of the external sync/system. ( Valid / Invalid / Missing / Confidential) |
| SubTasks[] | List of Subtasks defined for this external integration item (child descendent relationship) |
| Linked[] | List of linked external items defined for this integration item (sibling relationship) |
| CustomProperties[] | Custom Properties that have been mapped and defined per integration config |
| IsCompleted | True if this integration item is in a Completed state, False if not |
| IsInProgress | True if this integration item is in a In Progress state, False if not |
| IsNotStarted | True if this integration item is in a Not Started state, False if not |
SubTasks[]
SubTask integration items are items that have a parent child relationship to the current Integrated item. The are direct descendants of this Integration item.
| Name | Description |
| Id | The Id integer, uniquely identifies this particular external subtask item in the external system |
| Title | Title of the external subtask item |
| Status | Status name of the external subtask item |
| StatusCode | Status Code as it is resolved into Fluid Statuses |
| Description | Description of the external subtask item |
| PercentageComplete | What percentage of the external subtask item has been completed |
| StartDate | Start timestamp of the external subtask itemif mapped and any |
| DueDate | Due timestamp of the external subtask itemif mapped and any |
| EndDate | End timestamp of the external subtask itemif mapped and any |
| Priority | Priority of the external subtask item if mapped and any |
| NotStartedCount | Total number of subtasks for the external subtask item that are in a NotStarted status (NotStarted statuses are defined as per integrated config) |
| InProgressCount | Total number of subtasks for the external subtask item that are in a In Progress status (In Progress statuses are defined as per integrated config) |
| CompletedCount | Total number of subtasks for the external subtask item that are in a Completed status (Completed statuses are defined as per integrated config) |
| NotStartedPercentage | Not started as a percentage (%) |
| InProgressPercentage | In Progress as a percentage (%) |
| CompletedPercentage | Completed as a percentage (%) |
| Points | Points allocated to this external subtask item if mapped and any |
| BusinessValue | BusinessValue allocated to this external subtask item if mapped and any |
| LastSync | Timestamp this external subtask item was last synced into Fluid |
| ExternalStatus | The status of the external sync/system. ( Valid / Invalid / Missing / Confidential) |
| IsCompleted | True if this integration item is in a Completed state, False if not |
| IsInProgress | True if this integration item is in a In Progress state, False if not |
| IsNotStarted | True if this integration item is in a Not Started state, False if not |
Linked[]
Linked integration items are items that have a sibling relationship to the current Integrated item. They are related via a link, not a parent child relationship.
| Name | Description |
| Id | The Id integer, uniquely identifies this particular external linked item in the external system |
| Title | Title of the external linked item |
| Status | Status name of the external linked item |
| StatusCode | Status Code as it is resolved into Fluid Statuses |
| Description | Description of the external linked item |
| PercentageComplete | What percentage of the external linked item has been completed |
| StartDate | Start timestamp of the external linked item if mapped and any |
| DueDate | Due timestamp of the external linked itemif mapped and any |
| EndDate | End timestamp of the external linked itemif mapped and any |
| Priority | Priority of the external linked itemif mapped and any |
| NotStartedCount | Total number of subtasks for the external linked item that are in a NotStarted status (NotStarted statuses are defined as per integrated config) |
| InProgressCount | Total number of subtasks for the external linked item that are in a In Progress status (In Progress statuses are defined as per integrated config) |
| CompletedCount | Total number of subtasks for the external linked item that are in a Completed status (Completed statuses are defined as per integrated config) |
| NotStartedPercentage | Not started as a percentage (%) |
| InProgressPercentage | In Progress as a percentage (%) |
| CompletedPercentage | Completed as a percentage (%) |
| Points | Points allocated to this external subtask item if mapped and any |
| BusinessValue | BusinessValue allocated to this external subtask item if mapped and any |
| LastSync | Timestamp this external subtask item was last synced into Fluid |
| ExternalStatus | The status of the external sync/system. ( Valid / Invalid / Missing / Confidential) |
| IsCompleted | True if this integration item is in a Completed state, False if not |
| IsInProgress | True if this integration item is in a In Progress state, False if not |
| IsNotStarted | True if this integration item is in a Not Started state, False if not |
CustomProperties[]
| Name | Description |
| Name | Name of the Custom Property as mapped per integration config |
| Value[] | List of value(s) for this Custom Property |
| SyncMode | The sync mode this Custom Property per integration config |
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) |
Chat[]
Properties returned for requested expanded value set on query param "expand=chat", chat are comments/chat conversations that are associated with this entity
| Name | Description |
| Id | Unique id that represents this chat message |
| Content | Text only representation of the content of the chat message |
| TopicId | The topic Id/chat room this chat message has been post to |
| Display | Html version of the content that is displayed to the user |
| Initiator | The user that posted this chat message |
| Timestamp | The timestamp when this chat message was posted |
| Title | The title of the chat room this chat message was posted to |
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