Get Document Workflow Collection

Retrieve the full workflow collection of a document in Basecone.

GET documents/:documentId/workflow

Workflow collection properties

Property Type Description
documentWorkflowHistory Array A list of workflows.
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

Workflow properties

Property Type Description
created DateTime The date when the document entered that state.
status string The status that the document entered.
user complex Information about the user that caused that state for the document.

Example response:

            {
                "documentWorkflowHistory": [
                    {
                        "created": "2021-05-19T15:47:50.61",
                        "status": "Uploaded",
                        "user": {
                            "userId": "b652fbc8-631e-4ad7-b656-5d6584ce6144",
                            "_links": [
                                {
                                    "rel": "self",
                                    "href": "http://localhost:54634/users/b652fbc8-631e-4ad7-b656-5d6584ce6144"
                                }
                            ],
                            "name": "Aguas",
                            "userName": "Aguas"
                        }
                    },
                    {
                        "created": "2021-05-19T15:47:50.61",
                        "status": "Linked",
                        "user": {
                            "userId": "b652fbc8-631e-4ad7-b656-5d6584ce6144",
                            "_links": [
                                {
                                    "rel": "self",
                                    "href": "http://localhost:54634/users/b652fbc8-631e-4ad7-b656-5d6584ce6144"
                                }
                            ],
                            "name": "Aguas",
                            "userName": "Aguas"
                        }
                    },
                    {
                        "created": "2021-05-21T13:44:05.197",
                        "status": "Abandoned",
                        "user": {
                            "userId": "b652fbc8-631e-4ad7-b656-5d6584ce6144",
                            "_links": [
                                {
                                    "rel": "self",
                                    "href": "http://localhost:54634/users/b652fbc8-631e-4ad7-b656-5d6584ce6144"
                                }
                            ],
                            "name": "Aguas",
                            "userName": "Aguas"
                        }
                    }
                ],
                "_links": null,
                "_metadata": {
                    "total": 3
                }
            }