Delete Action

Modified on Wed, 12 Jun at 3:43 PM


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.0

cURL

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


NameInRequiredTypeDescription
fieldsqueryfalsestringComma-separated list of requested fields to return in the response
expandqueryfalsestringExpand parameter for Action attributes. Possible options are{"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"}
versionqueryfalsestringVersion of the API to use. if not set, default latest version will be used.


Response


NameTypeDescription
200 OKActionsuccessful operation
400stringBad Request
401stringNot an authorised user, username or token is invalid
403stringForbidden, user is not permissioned to perform the operation in this particular context
422stringInvalid arguments, request, query or body arguments are invalid
429string"Too many Requests" see response headers RateLimit-Limit (current rate limit capacity), RateLimit-Remaining (remaining tokens), RateLimit-Reset (time till next refill)


Response Headers


NameTypeDescription
RateLimit-Limit stringMax rate limit of requests allowed 
RateLimit-Remaining stringRemaining capacity of requests allowed 
RateLimit-Reset stringNext date time for refresh of capacity 


Definitions


NameDescription
idThe Id integer, uniquely identifies this particular Action, can be interchangeable with guid, see below
guidThe guid string, uniquely identifies this particular Action, can be interchangeable with id, see above
urlThe REST GET Url for this Action
fieldsMap of field and values for the Action
assignee[]Describes a list of users this action has been assigned to
authorDescribes the user who authored this Action
modifiedByDescribes the user who last modified this Action
owners[]Describes a list of users this action is owned by



Assignee[]


NameDescription
idThe Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below
guidThe guid string, uniquely identifies this particular User, can be interchangeable with id, see above
nameThe long name of this User
usernameThe username associated with this User
emailUnique email associated with this User


Author


NameDescription
idThe Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below
guidThe guid string, uniquely identifies this particular User, can be interchangeable with id, see above
nameThe long name of this User
usernameThe username associated with this User
emailUnique email associated with this User


ModifiedBy


NameDescription
idThe Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below
guidThe guid string, uniquely identifies this particular User, can be interchangeable with id, see above
nameThe long name of this User
usernameThe username associated with this User
emailUnique email associated with this User



Owners[]


NameDescription
idThe Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below
guidThe guid string, uniquely identifies this particular User, can be interchangeable with id, see above
nameThe long name of this User
usernameThe username associated with this User
emailUnique 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[]


NameDescription
guidThe guid string, uniquely identifies this particular custom property
dataTypeThe data type of the value for this Custom Property. eg string, datetime etc
isAdminLocked
isCatalogTypeCustom Property is a Catalog Type and is used as part of taxonomy
isMultipleCan contain multiple values
isSubType
keyUnique name key that identifies this Custom Property by name
requiredFlag to indicate this Custom Property requires a valid value
reportableFlag to indicate this Custom Property is reportable
readOnlyFlag to indicate value is read only and cannot be changed
valueThe 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.



NameDescription
typeThe type of action this method performs
httpMethodHTTP Request Method verb
urlThe REST URL that can be used with the Http Method verb
descriptionDescription of what this method performs
payloadSample 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



NameDescription
ParentParent related item to this Action
FromThis 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[]



NameDescription
IdThe Id integer, uniquely identifies this particular Action, can be interchangeable with guid, see below
GuidThe guid string, uniquely identifies this particular Action, can be interchangeable with id, see above
TitleTitle of this Action
NameName if this Action
CreatedDateTimestamp this Action was created
ModifiedDateTimestamp this Action was last modified
TypeType of this Action
StatusStatus of this Action
DescriptionDescription of this Action
PercentageCompleteWas percentage of this Action has been completed
Methods[]Array of REST API Methods that this Action can perform
ExternalReferenceIf this Action has a reference to an external integration or system, the external reference id is displayed here
ReferenceIdFluid internal reference identifier
PrincipalThe principal container for this Action
AssignedToUser that has been assigned this Action
RagStatusRAG status of this Action if appropriate
StartDateStart timestamp of this Action
DueDateDue timestamp of this Action
OwnerOwner of this Action
PriorityPriority of this Action
ModifiedByUser that last modified this Action
ParentGuidParent guid identifier for this Action
AttachmentCountNumber of attachments associated with this Action
ContentTypeThe content type of this Action



Children[]



NameDescription
IdThe Id integer, uniquely identifies this particular Action, can be interchangeable with guid, see below
GuidThe guid string, uniquely identifies this particular Action, can be interchangeable with id, see above
TitleTitle of this Action
NameName if this Action
CreatedDateTimestamp this Action was created
ModifiedDateTimestamp this Action was last modified
TypeType of this Action
StatusStatus of this Action
DescriptionDescription of this Action
PercentageCompleteWas percentage of this Action has been completed
Methods[]Array of REST API Methods that this Action can perform
ExternalReferenceIf this Action has a reference to an external integration or system, the external reference id is displayed here
ReferenceIdFluid internal reference identifier
PrincipalThe principal container for this Action
AssignedToUser that has been assigned this Action
RagStatusRAG status of this Action if appropriate
StartDateStart timestamp of this Action
DueDateDue timestamp of this Action
OwnerOwner of this Action
PriorityPriority of this Action
ModifiedByUser that last modified this Action
ParentGuidParent guid identifier for this Action
AttachmentCountNumber of attachments associated with this Action
ContentTypeThe content type of this Action



Project[]



NameDescription
IdThe Id integer, uniquely identifies this particular Project, can be interchangeable with guid, see below
GuidThe guid string, uniquely identifies this particular Project, can be interchangeable with id, see above
CategoryThe Category this Project aligns to
ProjectManagerThe user assigned as the Project Manager for this Project
DescriptionDescription of this Project
ExternalReferenceExternal Reference identifier for this Project
NameName if this Project
TypeType of this Project
StatusStatus of this Project 
OwnerOwner of this Project 
ParentGuidParent guid identifier for this Action


Catalog[]



NameDescription
IdThe Id integer, uniquely identifies this particular Catalog, can be interchangeable with guid, see below
GuidThe guid string, uniquely identifies this particular Action, can be interchangeable with id, see above
NameName if this Catalog 
ReferenceIdReference id of this Catalog
CatalogTypeGuidUnique 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.



NameDescription
IdThe Id integer, uniquely identifies this particular Attachment
GuidThe guid string, uniquely identifies this particular Attachment
TitleTitle of this Attachment
ModifiedDateTimestamp this Attachment was last modified
TypeType of this Attachment
StatusStatus of this Attachment
FilenameFilename of the attachment
UrlUrl to open/view or download this Attachmemt
ModifiedByUser 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 



NameDescription
IdThe Id integer, uniquely identifies this particular Integrated item, can be interchangeable with guid, see below
GuidThe guid string, uniquely identifies this particular Integrated item, can be interchangeable with id, see above
TitleTitle of this Integrated item
NameName if this Integrated item 
CreatedDateTimestamp this Integrated item was created
ModifiedDateTimestamp this Integrated item was last modified
TypeType of this Integrated item 
StatusStatus name of this Integrated item 
StatusCodeStatus Code as it is resolved into Fluid Statuses
DescriptionDescription of this Integrated item 
PercentageCompleteWas percentage of this Integrated item has been completed
ExternalReferenceThe unique external reference id of the external system
ReferenceIdFluid internal reference identifier
PrincipalThe principal container for this Integrated item 
AssignedToUser that has been assigned this Integrated item 
StartDateStart timestamp of this Integrated itemif mapped and any 
DueDateDue timestamp of this Integrated itemif mapped and any 
EndDateEnd timestamp of this Integrated itemif mapped and any 
OwnerOwner of this Integrated item 
PriorityPriority of this Integrated itemif mapped and any 
ModifiedByUser that last modified this Integrated item 
ParentGuidParent guid identifier for this Integrated item 
AttachmentCountNumber of attachments associated with this Integrated item
NotStartedCountTotal number of subtasks for this Integrated item that are in a NotStarted status (NotStarted statuses are defined as per integrated config)
InProgressCountTotal number of subtasks for this Integrated item that are in a In Progress
status (In Progress statuses are defined as per integrated config)
CompletedCountTotal number of subtasks for this Integrated item that are in a Completed
status (Completed statuses are defined as per integrated config)
NotStartedPercentageNot started as a percentage (%)
InProgressPercentageIn Progress as a percentage (%)
CompletedPercentageCompleted as a percentage (%)
PointsPoints allocated to this item if mapped and any 
BusinessValueBusinessValue allocated to this item if mapped and any
LastSyncTimestamp this item was last synced into Fluid
ExternalStatusThe 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
IsCompletedTrue if this integration item is in a Completed state, False if not
IsInProgressTrue if this integration item is in a In Progress state, False if not
IsNotStartedTrue 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.




NameDescription
IdThe Id integer, uniquely identifies this particular external subtask item in the external system
TitleTitle of the external subtask item
StatusStatus name of the external subtask item 
StatusCodeStatus Code as it is resolved into Fluid Statuses
DescriptionDescription of the external subtask item 
PercentageCompleteWhat percentage of the external subtask item has been completed
StartDateStart timestamp of the external subtask itemif mapped and any 
DueDateDue timestamp of the external subtask itemif mapped and any 
EndDateEnd timestamp of the external subtask itemif mapped and any 
PriorityPriority of the external subtask item if mapped and any 
NotStartedCountTotal number of subtasks for the external subtask item that are in a NotStarted status (NotStarted statuses are defined as per integrated config)
InProgressCountTotal number of subtasks for the external subtask item that are in a In Progress
status (In Progress statuses are defined as per integrated config)
CompletedCountTotal number of subtasks for the external subtask item that are in a Completed
status (Completed statuses are defined as per integrated config)
NotStartedPercentageNot started as a percentage (%)
InProgressPercentageIn Progress as a percentage (%)
CompletedPercentageCompleted as a percentage (%)
PointsPoints allocated to this external subtask item if mapped and any
BusinessValueBusinessValue allocated to this external subtask item if mapped and any
LastSyncTimestamp this external subtask item was last synced into Fluid
ExternalStatusThe status of the external sync/system. ( Valid / Invalid / Missing / Confidential)
IsCompletedTrue if this integration item is in a Completed state, False if not
IsInProgressTrue if this integration item is in a In Progress state, False if not
IsNotStartedTrue 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.



NameDescription
IdThe Id integer, uniquely identifies this particular external linked item in the external system
TitleTitle of the external linked item
StatusStatus name of the external linked item 
StatusCodeStatus Code as it is resolved into Fluid Statuses
DescriptionDescription of the external linked item 
PercentageCompleteWhat percentage of the external linked item has been completed
StartDateStart timestamp of the external linked item if mapped and any
DueDateDue timestamp of the external linked itemif mapped and any 
EndDateEnd timestamp of the external linked itemif mapped and any 
PriorityPriority of the external linked itemif mapped and any 
NotStartedCountTotal number of subtasks for the external linked item that are in a NotStarted status (NotStarted statuses are defined as per integrated config)
InProgressCountTotal number of subtasks for the external linked item that are in a In Progress
status (In Progress statuses are defined as per integrated config)
CompletedCountTotal number of subtasks for the external linked item that are in a Completed
status (Completed statuses are defined as per integrated config)
NotStartedPercentageNot started as a percentage (%)
InProgressPercentageIn Progress as a percentage (%)
CompletedPercentageCompleted as a percentage (%)
PointsPoints allocated to this external subtask item if mapped and any
BusinessValueBusinessValue allocated to this external subtask item if mapped and any
LastSyncTimestamp this external subtask item was last synced into Fluid
ExternalStatusThe status of the external sync/system. ( Valid / Invalid / Missing / Confidential)
IsCompletedTrue if this integration item is in a Completed state, False if not
IsInProgressTrue if this integration item is in a In Progress state, False if not
IsNotStartedTrue if this integration item is in a Not Started state, False if not




CustomProperties[]



NameDescription
NameName of the Custom Property as mapped per integration config
Value[]List of value(s) for this Custom Property
SyncModeThe 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.



NameDescription
TitleThe title of the checklist item
StatusThe 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



NameDescription
IdUnique id that represents this chat message
ContentText only representation of the content of the chat message
TopicIdThe topic Id/chat room this chat message has been post to
DisplayHtml version of the content that is displayed to the user
InitiatorThe user that posted this chat message
TimestampThe timestamp when this chat message was posted
TitleThe 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

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article