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
CommonResponseDetailDTOName | 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": "735c12c1-d653-41d2-89da-ae53d3a579b8", "DataMartID": "aac02d1a-2676-4dc5-9487-e8768b7c89fa", "DataMart": "sample string 3", "Status": 1, "Priority": 0, "DueDate": "2024-05-15T00:51:24Z", "ErrorMessage": "sample string 4", "ErrorDetail": "sample string 5", "RejectReason": "sample string 6", "ResultsGrouped": true, "Properties": "sample string 7", "RoutingType": 0, "ResponseID": "f3339a11-fab1-4053-b518-4cb38c7835b2", "ResponseGroupID": "a6955555-d521-432b-ad54-ec751d337590", "ResponseGroup": "sample string 8", "ResponseMessage": "sample string 9", "ResponseSubmittedOn": "2024-05-15T00:51:24Z", "ResponseSubmittedByID": "d580fa3c-498f-4fa6-a5b9-69c24e4e8ede", "ResponseSubmittedBy": "sample string 10", "ResponseTime": "2024-05-15T00:51:24Z", "ID": "99b24c1d-0c63-437e-b42e-854826701c13", "Timestamp": "QEA=" }, { "RequestID": "735c12c1-d653-41d2-89da-ae53d3a579b8", "DataMartID": "aac02d1a-2676-4dc5-9487-e8768b7c89fa", "DataMart": "sample string 3", "Status": 1, "Priority": 0, "DueDate": "2024-05-15T00:51:24Z", "ErrorMessage": "sample string 4", "ErrorDetail": "sample string 5", "RejectReason": "sample string 6", "ResultsGrouped": true, "Properties": "sample string 7", "RoutingType": 0, "ResponseID": "f3339a11-fab1-4053-b518-4cb38c7835b2", "ResponseGroupID": "a6955555-d521-432b-ad54-ec751d337590", "ResponseGroup": "sample string 8", "ResponseMessage": "sample string 9", "ResponseSubmittedOn": "2024-05-15T00:51:24Z", "ResponseSubmittedByID": "d580fa3c-498f-4fa6-a5b9-69c24e4e8ede", "ResponseSubmittedBy": "sample string 10", "ResponseTime": "2024-05-15T00:51:24Z", "ID": "99b24c1d-0c63-437e-b42e-854826701c13", "Timestamp": "QEA=" } ], "Responses": [ { "RequestDataMartID": "ee7b859e-64d9-480b-a957-ab6a1a8afa03", "ResponseGroupID": "246ff9f4-2a34-4a30-9b98-76da6ffe6cdd", "RespondedByID": "8e5e12c5-1d5f-4ca5-9232-6f892052f556", "ResponseTime": "2024-05-15T00:51:24Z", "Count": 2, "SubmittedOn": "2024-05-15T00:51:24Z", "SubmittedByID": "126e5593-533f-433c-958d-74d33c031252", "SubmitMessage": "sample string 5", "ResponseMessage": "sample string 6", "ID": "d96fb398-2257-4a16-9710-ffa9a0f80138", "Timestamp": "QEA=" }, { "RequestDataMartID": "ee7b859e-64d9-480b-a957-ab6a1a8afa03", "ResponseGroupID": "246ff9f4-2a34-4a30-9b98-76da6ffe6cdd", "RespondedByID": "8e5e12c5-1d5f-4ca5-9232-6f892052f556", "ResponseTime": "2024-05-15T00:51:24Z", "Count": 2, "SubmittedOn": "2024-05-15T00:51:24Z", "SubmittedByID": "126e5593-533f-433c-958d-74d33c031252", "SubmitMessage": "sample string 5", "ResponseMessage": "sample string 6", "ID": "d96fb398-2257-4a16-9710-ffa9a0f80138", "Timestamp": "QEA=" } ], "Documents": [ { "Name": "sample string 1", "FileName": "sample string 2", "Viewable": true, "MimeType": "sample string 4", "Kind": "sample string 5", "Length": 6, "ItemID": "387b8003-c680-4cdd-8570-b67a56c41ffc", "CreatedOn": "2024-05-15T00:51:24Z", "ContentModifiedOn": "2024-05-15T00:51:24Z", "ContentCreatedOn": "2024-05-15T00:51:24Z", "ItemTitle": "sample string 9", "Description": "sample string 10", "ParentDocumentID": "c7e8a4fb-e415-400a-a394-31df084406fa", "UploadedByID": "cf7ca524-3531-49aa-86c2-e0f569fb71e5", "UploadedBy": "sample string 11", "RevisionSetID": "536d7a54-2e31-4b0f-bee9-86a39793adc5", "RevisionDescription": "sample string 12", "MajorVersion": 13, "MinorVersion": 14, "BuildVersion": 15, "RevisionVersion": 16, "TaskItemType": 1, "DocumentType": 0, "ID": "125c7824-dbfc-4790-8104-f0481310c5cc", "Timestamp": "QEA=" }, { "Name": "sample string 1", "FileName": "sample string 2", "Viewable": true, "MimeType": "sample string 4", "Kind": "sample string 5", "Length": 6, "ItemID": "387b8003-c680-4cdd-8570-b67a56c41ffc", "CreatedOn": "2024-05-15T00:51:24Z", "ContentModifiedOn": "2024-05-15T00:51:24Z", "ContentCreatedOn": "2024-05-15T00:51:24Z", "ItemTitle": "sample string 9", "Description": "sample string 10", "ParentDocumentID": "c7e8a4fb-e415-400a-a394-31df084406fa", "UploadedByID": "cf7ca524-3531-49aa-86c2-e0f569fb71e5", "UploadedBy": "sample string 11", "RevisionSetID": "536d7a54-2e31-4b0f-bee9-86a39793adc5", "RevisionDescription": "sample string 12", "MajorVersion": 13, "MinorVersion": 14, "BuildVersion": 15, "RevisionVersion": 16, "TaskItemType": 1, "DocumentType": 0, "ID": "125c7824-dbfc-4790-8104-f0481310c5cc", "Timestamp": "QEA=" } ], "CanViewPendingApprovalResponses": true, "ExportForFileDistribution": true } ] }
text/javascript
Sample:
{"results":[{"RequestDataMarts":[{"RequestID":"735c12c1-d653-41d2-89da-ae53d3a579b8","DataMartID":"aac02d1a-2676-4dc5-9487-e8768b7c89fa","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-15T00:51:24Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"f3339a11-fab1-4053-b518-4cb38c7835b2","ResponseGroupID":"a6955555-d521-432b-ad54-ec751d337590","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-15T00:51:24Z","ResponseSubmittedByID":"d580fa3c-498f-4fa6-a5b9-69c24e4e8ede","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-15T00:51:24Z","ID":"99b24c1d-0c63-437e-b42e-854826701c13","Timestamp":"QEA="},{"RequestID":"735c12c1-d653-41d2-89da-ae53d3a579b8","DataMartID":"aac02d1a-2676-4dc5-9487-e8768b7c89fa","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-15T00:51:24Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"f3339a11-fab1-4053-b518-4cb38c7835b2","ResponseGroupID":"a6955555-d521-432b-ad54-ec751d337590","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-15T00:51:24Z","ResponseSubmittedByID":"d580fa3c-498f-4fa6-a5b9-69c24e4e8ede","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-15T00:51:24Z","ID":"99b24c1d-0c63-437e-b42e-854826701c13","Timestamp":"QEA="}],"Responses":[{"RequestDataMartID":"ee7b859e-64d9-480b-a957-ab6a1a8afa03","ResponseGroupID":"246ff9f4-2a34-4a30-9b98-76da6ffe6cdd","RespondedByID":"8e5e12c5-1d5f-4ca5-9232-6f892052f556","ResponseTime":"2024-05-15T00:51:24Z","Count":2,"SubmittedOn":"2024-05-15T00:51:24Z","SubmittedByID":"126e5593-533f-433c-958d-74d33c031252","SubmitMessage":"sample string 5","ResponseMessage":"sample string 6","ID":"d96fb398-2257-4a16-9710-ffa9a0f80138","Timestamp":"QEA="},{"RequestDataMartID":"ee7b859e-64d9-480b-a957-ab6a1a8afa03","ResponseGroupID":"246ff9f4-2a34-4a30-9b98-76da6ffe6cdd","RespondedByID":"8e5e12c5-1d5f-4ca5-9232-6f892052f556","ResponseTime":"2024-05-15T00:51:24Z","Count":2,"SubmittedOn":"2024-05-15T00:51:24Z","SubmittedByID":"126e5593-533f-433c-958d-74d33c031252","SubmitMessage":"sample string 5","ResponseMessage":"sample string 6","ID":"d96fb398-2257-4a16-9710-ffa9a0f80138","Timestamp":"QEA="}],"Documents":[{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"387b8003-c680-4cdd-8570-b67a56c41ffc","CreatedOn":"2024-05-15T00:51:24Z","ContentModifiedOn":"2024-05-15T00:51:24Z","ContentCreatedOn":"2024-05-15T00:51:24Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"c7e8a4fb-e415-400a-a394-31df084406fa","UploadedByID":"cf7ca524-3531-49aa-86c2-e0f569fb71e5","UploadedBy":"sample string 11","RevisionSetID":"536d7a54-2e31-4b0f-bee9-86a39793adc5","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"125c7824-dbfc-4790-8104-f0481310c5cc","Timestamp":"QEA="},{"Name":"sample string 1","FileName":"sample string 2","Viewable":true,"MimeType":"sample string 4","Kind":"sample string 5","Length":6,"ItemID":"387b8003-c680-4cdd-8570-b67a56c41ffc","CreatedOn":"2024-05-15T00:51:24Z","ContentModifiedOn":"2024-05-15T00:51:24Z","ContentCreatedOn":"2024-05-15T00:51:24Z","ItemTitle":"sample string 9","Description":"sample string 10","ParentDocumentID":"c7e8a4fb-e415-400a-a394-31df084406fa","UploadedByID":"cf7ca524-3531-49aa-86c2-e0f569fb71e5","UploadedBy":"sample string 11","RevisionSetID":"536d7a54-2e31-4b0f-bee9-86a39793adc5","RevisionDescription":"sample string 12","MajorVersion":13,"MinorVersion":14,"BuildVersion":15,"RevisionVersion":16,"TaskItemType":1,"DocumentType":0,"ID":"125c7824-dbfc-4790-8104-f0481310c5cc","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.