GET Response/GetForWorkflowRequest?requestID={requestID}&viewDocuments={viewDocuments}

Gets all the details for the responses associated to the specified requests current workflow activity.

Request Information

URI Parameters

Name	Description	Type	Additional information
requestID	The ID of the request.	globally unique identifier	Required
viewDocuments	Optional flag if one wants the documents included. Defaults to false	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

CommonResponseDetailDTO

Name	Description	Type	Additional information
RequestDataMarts	Available Request Datamarts	Collection of RequestDataMartDTO	None.
Responses	Responses	Collection of ResponseDTO	None.
Documents	Available Documents	Collection of ExtendedDocumentDTO	None.
CanViewPendingApprovalResponses	Indicates if the requesting user can approve or reject the responses.	boolean	None.
ExportForFileDistribution		boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {
      "RequestDataMarts": [
        {
          "RequestID": "0462c985-9e52-4c2e-bdae-3e483f6481e5",
          "DataMartID": "55ede84f-0b12-4881-a8f5-085b685a60be",
          "DataMart": "sample string 3",
          "Status": 1,
          "Priority": 0,
          "DueDate": "2024-05-13T18:22:20Z",
          "ErrorMessage": "sample string 4",
          "ErrorDetail": "sample string 5",
          "RejectReason": "sample string 6",
          "ResultsGrouped": true,
          "Properties": "sample string 7",
          "RoutingType": 0,
          "ResponseID": "bcc24a28-9c84-441e-8060-9da7fffa09bc",
          "ResponseGroupID": "984d45c4-52f8-4795-a448-cffc2a358690",
          "ResponseGroup": "sample string 8",
          "ResponseMessage": "sample string 9",
          "ResponseSubmittedOn": "2024-05-13T18:22:20Z",
          "ResponseSubmittedByID": "efcddf42-050a-4ebf-a63d-24f59e535286",
          "ResponseSubmittedBy": "sample string 10",
          "ResponseTime": "2024-05-13T18:22:20Z",
          "ID": "45112f9c-81eb-46fc-a877-96489a5ddad4",
          "Timestamp": "QEA="
        },
        {
          "RequestID": "0462c985-9e52-4c2e-bdae-3e483f6481e5",
          "DataMartID": "55ede84f-0b12-4881-a8f5-085b685a60be",
          "DataMart": "sample string 3",
          "Status": 1,
          "Priority": 0,
          "DueDate": "2024-05-13T18:22:20Z",
          "ErrorMessage": "sample string 4",
          "ErrorDetail": "sample string 5",
          "RejectReason": "sample string 6",
          "ResultsGrouped": true,
          "Properties": "sample string 7",
          "RoutingType": 0,
          "ResponseID": "bcc24a28-9c84-441e-8060-9da7fffa09bc",
          "ResponseGroupID": "984d45c4-52f8-4795-a448-cffc2a358690",
          "ResponseGroup": "sample string 8",
          "ResponseMessage": "sample string 9",
          "ResponseSubmittedOn": "2024-05-13T18:22:20Z",
          "ResponseSubmittedByID": "efcddf42-050a-4ebf-a63d-24f59e535286",
          "ResponseSubmittedBy": "sample string 10",
          "ResponseTime": "2024-05-13T18:22:20Z",
          "ID": "45112f9c-81eb-46fc-a877-96489a5ddad4",
          "Timestamp": "QEA="
        }
      ],
      "Responses": [
        {
          "RequestDataMartID": "d73b61ef-a128-49c3-b590-3b50bcfb2633",
          "ResponseGroupID": "26066d83-b8bf-4a5f-a3d1-21d46fe5a13f",
          "RespondedByID": "1d53eb84-5119-483b-8ca7-dbb666119744",
          "ResponseTime": "2024-05-13T18:22:20Z",
          "Count": 2,
          "SubmittedOn": "2024-05-13T18:22:20Z",
          "SubmittedByID": "50fe274e-5156-44a4-94a8-f83f527c80ac",
          "SubmitMessage": "sample string 5",
          "ResponseMessage": "sample string 6",
          "ID": "e1d54055-919b-4427-aa74-351618970ba7",
          "Timestamp": "QEA="
        },
        {
          "RequestDataMartID": "d73b61ef-a128-49c3-b590-3b50bcfb2633",
          "ResponseGroupID": "26066d83-b8bf-4a5f-a3d1-21d46fe5a13f",
          "RespondedByID": "1d53eb84-5119-483b-8ca7-dbb666119744",
          "ResponseTime": "2024-05-13T18:22:20Z",
          "Count": 2,
          "SubmittedOn": "2024-05-13T18:22:20Z",
          "SubmittedByID": "50fe274e-5156-44a4-94a8-f83f527c80ac",
          "SubmitMessage": "sample string 5",
          "ResponseMessage": "sample string 6",
          "ID": "e1d54055-919b-4427-aa74-351618970ba7",
          "Timestamp": "QEA="
        }
      ],
      "Documents": [
        {
          "Name": "sample string 1",
          "FileName": "sample string 2",
          "Viewable": true,
          "MimeType": "sample string 4",
          "Kind": "sample string 5",
          "Length": 6,
          "ItemID": "112afcf0-7222-456b-acac-ce36e3b86beb",
          "CreatedOn": "2024-05-13T18:22:20Z",
          "ContentModifiedOn": "2024-05-13T18:22:20Z",
          "ContentCreatedOn": "2024-05-13T18:22:20Z",
          "ItemTitle": "sample string 9",
          "Description": "sample string 10",
          "ParentDocumentID": "a188ee5f-2bc9-49bb-b9db-2d2d38385a1d",
          "UploadedByID": "ea894e55-f6ce-4209-a022-129d9880d125",
          "UploadedBy": "sample string 11",
          "RevisionSetID": "535e8a7f-6a3c-4640-87b6-8f49737d6eed",
          "RevisionDescription": "sample string 12",
          "MajorVersion": 13,
          "MinorVersion": 14,
          "BuildVersion": 15,
          "RevisionVersion": 16,
          "TaskItemType": 1,
          "DocumentType": 0,
          "ID": "cd6d8c8f-0adf-493e-8ad7-d1e641f6d48e",
          "Timestamp": "QEA="
        },
        {
          "Name": "sample string 1",
          "FileName": "sample string 2",
          "Viewable": true,
          "MimeType": "sample string 4",
          "Kind": "sample string 5",
          "Length": 6,
          "ItemID": "112afcf0-7222-456b-acac-ce36e3b86beb",
          "CreatedOn": "2024-05-13T18:22:20Z",
          "ContentModifiedOn": "2024-05-13T18:22:20Z",
          "ContentCreatedOn": "2024-05-13T18:22:20Z",
          "ItemTitle": "sample string 9",
          "Description": "sample string 10",
          "ParentDocumentID": "a188ee5f-2bc9-49bb-b9db-2d2d38385a1d",
          "UploadedByID": "ea894e55-f6ce-4209-a022-129d9880d125",
          "UploadedBy": "sample string 11",
          "RevisionSetID": "535e8a7f-6a3c-4640-87b6-8f49737d6eed",
          "RevisionDescription": "sample string 12",
          "MajorVersion": 13,
          "MinorVersion": 14,
          "BuildVersion": 15,
          "RevisionVersion": 16,
          "TaskItemType": 1,
          "DocumentType": 0,
          "ID": "cd6d8c8f-0adf-493e-8ad7-d1e641f6d48e",
          "Timestamp": "QEA="
        }
      ],
      "CanViewPendingApprovalResponses": true,
      "ExportForFileDistribution": true
    }
  ]
}

text/javascript

Sample:

{"results":[{"RequestDataMarts":[{"RequestID":"0462c985-9e52-4c2e-bdae-3e483f6481e5","DataMartID":"55ede84f-0b12-4881-a8f5-085b685a60be","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-13T18:22:20Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"bcc24a28-9c84-441e-8060-9da7fffa09bc","ResponseGroupID":"984d45c4-52f8-4795-a448-cffc2a358690","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-13T18:22:20Z","ResponseSubmittedByID":"efcddf42-050a-4ebf-a63d-24f59e535286","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-13T18:22:20Z","ID":"45112f9c-81eb-46fc-a877-96489a5ddad4","Timestamp":"QEA="},{"RequestID":"0462c985-9e52-4c2e-bdae-3e483f6481e5","DataMartID":"55ede84f-0b12-4881-a8f5-085b685a60be","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-13T18:22:20Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"bcc24a28-9c84-441e-8060-9da7fffa09bc","ResponseGroupID":"984d45c4-52f8-4795-a448-cffc2a358690","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-13T18:22:20Z","ResponseSubmittedByID":"efcddf42-050a-4ebf-a63d-24f59e535286","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-13T18:22:20Z","ID":"45112f9c-81eb-46fc-a877-96489a5ddad4","Timestamp":"QEA="}],"Responses":[{"RequestDataMartID":"d73b61ef-a128-49c3-b590-3b50bcfb2633","ResponseGroupID":"26066d83-b8bf-4a5f-a3d1-21d46fe5a13f","RespondedByID":"1d53eb84-5119-483b-8ca7-dbb666119744","ResponseTime":"2024-05-13T18:22:20Z","Count":2,"SubmittedOn":"2024-05-13T18:22:20Z","SubmittedByID":"50fe274e-5156-44a4-94a8-f83f527c80ac","SubmitMessage":"sample string 5","ResponseMessage":"sample string 6","ID":"e1d54055-919b-4427-aa74-351618970ba7","Timestamp":"QEA="},{"RequestDataMartID":"d73b61ef-a128-49c3-b590-3b50bcfb2633","ResponseGroupID":"26066d83-b8bf-4a5f-a3d1-21d46fe5a13f","RespondedByID":"1d53eb84-5119-483b-8ca7-dbb666119744","ResponseTime":"2024-05-13T18:22:20Z","Count":2,"SubmittedOn":"2024-05-13T18:22:20Z","SubmittedByID":"50fe274e-5156-44a4-94a8-f83f527c80ac","SubmitMessage":"sample string 5","ResponseMessage":"sample string 6","ID":"e1d54055-919b-4427-aa74-351618970ba7","Timestamp":"QEA="}],"Documents":[{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"112afcf0-7222-456b-acac-ce36e3b86beb","CreatedOn":"2024-05-13T18:22:20Z","ContentModifiedOn":"2024-05-13T18:22:20Z","ContentCreatedOn":"2024-05-13T18:22:20Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"a188ee5f-2bc9-49bb-b9db-2d2d38385a1d","UploadedByID":"ea894e55-f6ce-4209-a022-129d9880d125","UploadedBy":"sample string 11","RevisionSetID":"535e8a7f-6a3c-4640-87b6-8f49737d6eed","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"cd6d8c8f-0adf-493e-8ad7-d1e641f6d48e","Timestamp":"QEA="},{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"112afcf0-7222-456b-acac-ce36e3b86beb","CreatedOn":"2024-05-13T18:22:20Z","ContentModifiedOn":"2024-05-13T18:22:20Z","ContentCreatedOn":"2024-05-13T18:22:20Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"a188ee5f-2bc9-49bb-b9db-2d2d38385a1d","UploadedByID":"ea894e55-f6ce-4209-a022-129d9880d125","UploadedBy":"sample string 11","RevisionSetID":"535e8a7f-6a3c-4640-87b6-8f49737d6eed","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"cd6d8c8f-0adf-493e-8ad7-d1e641f6d48e","Timestamp":"QEA="}],"CanViewPendingApprovalResponses":true,"ExportForFileDistribution":true}]}

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.