POST Requests/CompleteWorkflowActivity

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

RequestCompletionResponseDTO
NameDescriptionTypeAdditional information
Uri

Url

string

None.

Entity

Gets or sets the entities

RequestDTO

None.

DataMarts

Available DataMarts

Collection of RequestDataMartDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "Uri": "sample string 1",
      "Entity": {
        "Identifier": 1,
        "MSRequestID": "sample string 2",
        "ProjectID": "126e4273-9fb1-4a8c-9e81-64e71c8371f9",
        "Project": "sample string 4",
        "Name": "sample string 5",
        "Description": "sample string 6",
        "AdditionalInstructions": "sample string 7",
        "UpdatedOn": "2024-05-13T22:09:44Z",
        "UpdatedByID": "6645b1a3-b52d-4472-854f-b74bcb302525",
        "UpdatedBy": "sample string 10",
        "MirrorBudgetFields": true,
        "Scheduled": true,
        "Template": true,
        "Deleted": true,
        "Priority": 0,
        "OrganizationID": "519f71a2-4eb1-4ed6-b820-c90179499284",
        "Organization": "sample string 16",
        "PurposeOfUse": "sample string 17",
        "PhiDisclosureLevel": "sample string 18",
        "ReportAggregationLevelID": "10eb5f46-31cb-4afc-a0f1-404aec9a67c1",
        "ReportAggregationLevel": "sample string 19",
        "Schedule": "sample string 20",
        "ScheduleCount": 21,
        "SubmittedOn": "2024-05-13T22:09:44Z",
        "SubmittedByID": "6cb32afe-1f11-4610-85c2-1bade8584138",
        "SubmittedByName": "sample string 22",
        "SubmittedBy": "sample string 23",
        "RequestTypeID": "b7a0220e-bd04-4377-ac52-8c2d20a3a067",
        "RequestType": "sample string 25",
        "AdapterPackageVersion": "sample string 26",
        "IRBApprovalNo": "sample string 27",
        "DueDate": "2024-05-13T22:09:44Z",
        "ActivityDescription": "sample string 28",
        "ActivityID": "7e519a76-69b0-4d6a-bdb7-67d277c26e66",
        "SourceActivityID": "9050d315-eb28-4e4e-a6e5-d78d5d5f27de",
        "SourceActivityProjectID": "36e4bb53-d4a0-441a-a8a5-5afd6375b201",
        "SourceTaskOrderID": "8194b7aa-45a1-4781-826b-40d61f8b9bbc",
        "RequesterCenterID": "08052fb7-5da7-4568-b0a5-9d9855e638bc",
        "RequesterCenter": "sample string 29",
        "WorkplanTypeID": "a9fa56ed-0800-4ff7-99fc-70b6d3d216a2",
        "WorkplanType": "sample string 30",
        "WorkflowID": "9832c2eb-5d6b-47ae-9668-a4a8bac84bb5",
        "Workflow": "sample string 31",
        "CurrentWorkFlowActivityID": "46895c4a-8883-4ba6-aad6-7117ff63ce56",
        "CurrentWorkFlowActivity": "sample string 32",
        "Status": 100,
        "StatusText": "sample string 33",
        "MajorEventDate": "2024-05-13T22:09:44Z",
        "MajorEventByID": "032b0898-4967-4a52-b179-bcf4ba79972e",
        "MajorEventBy": "sample string 36",
        "CreatedOn": "2024-05-13T22:09:44Z",
        "CreatedByID": "bf5e0ac9-3d20-497f-ac2b-f6f7fadfaa9d",
        "CreatedBy": "sample string 39",
        "CompletedOn": "2024-05-13T22:09:44Z",
        "CancelledOn": "2024-05-13T22:09:44Z",
        "UserIdentifier": "sample string 40",
        "Query": "sample string 41",
        "ParentRequestID": "826f2c93-e8c7-4098-adec-e0a3866a2f35",
        "ID": "84cce44e-9652-464a-a6b2-a9cc73c9eda9",
        "Timestamp": "QEA="
      },
      "DataMarts": [
        {
          "RequestID": "f32ec352-2bc0-477f-ae92-8337d04564f9",
          "DataMartID": "896c2ab0-bf1e-4c05-895a-b9a04f108c43",
          "DataMart": "sample string 3",
          "Status": 1,
          "Priority": 0,
          "DueDate": "2024-05-13T22:09:44Z",
          "ErrorMessage": "sample string 4",
          "ErrorDetail": "sample string 5",
          "RejectReason": "sample string 6",
          "ResultsGrouped": true,
          "Properties": "sample string 7",
          "RoutingType": 0,
          "ResponseID": "41a498c2-af60-4157-b7f5-fcfbaf381acb",
          "ResponseGroupID": "7358f69a-2efd-46a6-b5da-54830fa71b97",
          "ResponseGroup": "sample string 8",
          "ResponseMessage": "sample string 9",
          "ResponseSubmittedOn": "2024-05-13T22:09:44Z",
          "ResponseSubmittedByID": "9056acdf-1015-44c5-8ff6-1b493475dc10",
          "ResponseSubmittedBy": "sample string 10",
          "ResponseTime": "2024-05-13T22:09:44Z",
          "ID": "e4e49345-1722-486b-93f8-e855634260fc",
          "Timestamp": "QEA="
        },
        {
          "RequestID": "f32ec352-2bc0-477f-ae92-8337d04564f9",
          "DataMartID": "896c2ab0-bf1e-4c05-895a-b9a04f108c43",
          "DataMart": "sample string 3",
          "Status": 1,
          "Priority": 0,
          "DueDate": "2024-05-13T22:09:44Z",
          "ErrorMessage": "sample string 4",
          "ErrorDetail": "sample string 5",
          "RejectReason": "sample string 6",
          "ResultsGrouped": true,
          "Properties": "sample string 7",
          "RoutingType": 0,
          "ResponseID": "41a498c2-af60-4157-b7f5-fcfbaf381acb",
          "ResponseGroupID": "7358f69a-2efd-46a6-b5da-54830fa71b97",
          "ResponseGroup": "sample string 8",
          "ResponseMessage": "sample string 9",
          "ResponseSubmittedOn": "2024-05-13T22:09:44Z",
          "ResponseSubmittedByID": "9056acdf-1015-44c5-8ff6-1b493475dc10",
          "ResponseSubmittedBy": "sample string 10",
          "ResponseTime": "2024-05-13T22:09:44Z",
          "ID": "e4e49345-1722-486b-93f8-e855634260fc",
          "Timestamp": "QEA="
        }
      ]
    }
  ]
}

text/javascript

Sample:
{"results":[{"Uri":"sample string 1","Entity":{"Identifier":1,"MSRequestID":"sample string 2","ProjectID":"126e4273-9fb1-4a8c-9e81-64e71c8371f9","Project":"sample string 4","Name":"sample string 5","Description":"sample string 6","AdditionalInstructions":"sample string 7","UpdatedOn":"2024-05-13T22:09:44Z","UpdatedByID":"6645b1a3-b52d-4472-854f-b74bcb302525","UpdatedBy":"sample string 10","MirrorBudgetFields":true,"Scheduled":true,"Template":true,"Deleted":true,"Priority":0,"OrganizationID":"519f71a2-4eb1-4ed6-b820-c90179499284","Organization":"sample string 16","PurposeOfUse":"sample string 17","PhiDisclosureLevel":"sample string 18","ReportAggregationLevelID":"10eb5f46-31cb-4afc-a0f1-404aec9a67c1","ReportAggregationLevel":"sample string 19","Schedule":"sample string 20","ScheduleCount":21,"SubmittedOn":"2024-05-13T22:09:44Z","SubmittedByID":"6cb32afe-1f11-4610-85c2-1bade8584138","SubmittedByName":"sample string 22","SubmittedBy":"sample string 23","RequestTypeID":"b7a0220e-bd04-4377-ac52-8c2d20a3a067","RequestType":"sample string 25","AdapterPackageVersion":"sample string 26","IRBApprovalNo":"sample string 27","DueDate":"2024-05-13T22:09:44Z","ActivityDescription":"sample string 28","ActivityID":"7e519a76-69b0-4d6a-bdb7-67d277c26e66","SourceActivityID":"9050d315-eb28-4e4e-a6e5-d78d5d5f27de","SourceActivityProjectID":"36e4bb53-d4a0-441a-a8a5-5afd6375b201","SourceTaskOrderID":"8194b7aa-45a1-4781-826b-40d61f8b9bbc","RequesterCenterID":"08052fb7-5da7-4568-b0a5-9d9855e638bc","RequesterCenter":"sample string 29","WorkplanTypeID":"a9fa56ed-0800-4ff7-99fc-70b6d3d216a2","WorkplanType":"sample string 30","WorkflowID":"9832c2eb-5d6b-47ae-9668-a4a8bac84bb5","Workflow":"sample string 31","CurrentWorkFlowActivityID":"46895c4a-8883-4ba6-aad6-7117ff63ce56","CurrentWorkFlowActivity":"sample string 32","Status":100,"StatusText":"sample string 33","MajorEventDate":"2024-05-13T22:09:44Z","MajorEventByID":"032b0898-4967-4a52-b179-bcf4ba79972e","MajorEventBy":"sample string 36","CreatedOn":"2024-05-13T22:09:44Z","CreatedByID":"bf5e0ac9-3d20-497f-ac2b-f6f7fadfaa9d","CreatedBy":"sample string 39","CompletedOn":"2024-05-13T22:09:44Z","CancelledOn":"2024-05-13T22:09:44Z","UserIdentifier":"sample string 40","Query":"sample string 41","ParentRequestID":"826f2c93-e8c7-4098-adec-e0a3866a2f35","ID":"84cce44e-9652-464a-a6b2-a9cc73c9eda9","Timestamp":"QEA="},"DataMarts":[{"RequestID":"f32ec352-2bc0-477f-ae92-8337d04564f9","DataMartID":"896c2ab0-bf1e-4c05-895a-b9a04f108c43","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-13T22:09:44Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"41a498c2-af60-4157-b7f5-fcfbaf381acb","ResponseGroupID":"7358f69a-2efd-46a6-b5da-54830fa71b97","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-13T22:09:44Z","ResponseSubmittedByID":"9056acdf-1015-44c5-8ff6-1b493475dc10","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-13T22:09:44Z","ID":"e4e49345-1722-486b-93f8-e855634260fc","Timestamp":"QEA="},{"RequestID":"f32ec352-2bc0-477f-ae92-8337d04564f9","DataMartID":"896c2ab0-bf1e-4c05-895a-b9a04f108c43","DataMart":"sample string 3","Status":1,"Priority":0,"DueDate":"2024-05-13T22:09:44Z","ErrorMessage":"sample string 4","ErrorDetail":"sample string 5","RejectReason":"sample string 6","ResultsGrouped":true,"Properties":"sample string 7","RoutingType":0,"ResponseID":"41a498c2-af60-4157-b7f5-fcfbaf381acb","ResponseGroupID":"7358f69a-2efd-46a6-b5da-54830fa71b97","ResponseGroup":"sample string 8","ResponseMessage":"sample string 9","ResponseSubmittedOn":"2024-05-13T22:09:44Z","ResponseSubmittedByID":"9056acdf-1015-44c5-8ff6-1b493475dc10","ResponseSubmittedBy":"sample string 10","ResponseTime":"2024-05-13T22:09:44Z","ID":"e4e49345-1722-486b-93f8-e855634260fc","Timestamp":"QEA="}]}]}

application/bson

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

application/xml, text/xml

Sample:
<RequestCompletionResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <DataMarts>
    <RequestDataMartDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">e4e49345-1722-486b-93f8-e855634260fc</ID>
      <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
      <DataMart>sample string 3</DataMart>
      <DataMartID>896c2ab0-bf1e-4c05-895a-b9a04f108c43</DataMartID>
      <DueDate>2024-05-13T22:09:44.3492104-04:00</DueDate>
      <ErrorDetail>sample string 5</ErrorDetail>
      <ErrorMessage>sample string 4</ErrorMessage>
      <Priority>Low</Priority>
      <Properties>sample string 7</Properties>
      <RejectReason>sample string 6</RejectReason>
      <RequestID>f32ec352-2bc0-477f-ae92-8337d04564f9</RequestID>
      <ResponseGroup>sample string 8</ResponseGroup>
      <ResponseGroupID>7358f69a-2efd-46a6-b5da-54830fa71b97</ResponseGroupID>
      <ResponseID>41a498c2-af60-4157-b7f5-fcfbaf381acb</ResponseID>
      <ResponseMessage>sample string 9</ResponseMessage>
      <ResponseSubmittedBy>sample string 10</ResponseSubmittedBy>
      <ResponseSubmittedByID>9056acdf-1015-44c5-8ff6-1b493475dc10</ResponseSubmittedByID>
      <ResponseSubmittedOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-05-14T02:09:44.3492104Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </ResponseSubmittedOn>
      <ResponseTime>2024-05-13T22:09:44.3492104-04:00</ResponseTime>
      <ResultsGrouped>true</ResultsGrouped>
      <RoutingType>AnalysisCenter</RoutingType>
      <Status>Draft</Status>
    </RequestDataMartDTO>
    <RequestDataMartDTO>
      <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">e4e49345-1722-486b-93f8-e855634260fc</ID>
      <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
      <DataMart>sample string 3</DataMart>
      <DataMartID>896c2ab0-bf1e-4c05-895a-b9a04f108c43</DataMartID>
      <DueDate>2024-05-13T22:09:44.3492104-04:00</DueDate>
      <ErrorDetail>sample string 5</ErrorDetail>
      <ErrorMessage>sample string 4</ErrorMessage>
      <Priority>Low</Priority>
      <Properties>sample string 7</Properties>
      <RejectReason>sample string 6</RejectReason>
      <RequestID>f32ec352-2bc0-477f-ae92-8337d04564f9</RequestID>
      <ResponseGroup>sample string 8</ResponseGroup>
      <ResponseGroupID>7358f69a-2efd-46a6-b5da-54830fa71b97</ResponseGroupID>
      <ResponseID>41a498c2-af60-4157-b7f5-fcfbaf381acb</ResponseID>
      <ResponseMessage>sample string 9</ResponseMessage>
      <ResponseSubmittedBy>sample string 10</ResponseSubmittedBy>
      <ResponseSubmittedByID>9056acdf-1015-44c5-8ff6-1b493475dc10</ResponseSubmittedByID>
      <ResponseSubmittedOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2024-05-14T02:09:44.3492104Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </ResponseSubmittedOn>
      <ResponseTime>2024-05-13T22:09:44.3492104-04:00</ResponseTime>
      <ResultsGrouped>true</ResultsGrouped>
      <RoutingType>AnalysisCenter</RoutingType>
      <Status>Draft</Status>
    </RequestDataMartDTO>
  </DataMarts>
  <Entity>
    <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">84cce44e-9652-464a-a6b2-a9cc73c9eda9</ID>
    <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
    <ActivityDescription>sample string 28</ActivityDescription>
    <ActivityID>7e519a76-69b0-4d6a-bdb7-67d277c26e66</ActivityID>
    <AdapterPackageVersion>sample string 26</AdapterPackageVersion>
    <AdditionalInstructions>sample string 7</AdditionalInstructions>
    <CancelledOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </CancelledOn>
    <CompletedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </CompletedOn>
    <CreatedBy>sample string 39</CreatedBy>
    <CreatedByID>bf5e0ac9-3d20-497f-ac2b-f6f7fadfaa9d</CreatedByID>
    <CreatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </CreatedOn>
    <CurrentWorkFlowActivity>sample string 32</CurrentWorkFlowActivity>
    <CurrentWorkFlowActivityID>46895c4a-8883-4ba6-aad6-7117ff63ce56</CurrentWorkFlowActivityID>
    <Deleted>true</Deleted>
    <Description>sample string 6</Description>
    <DueDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </DueDate>
    <IRBApprovalNo>sample string 27</IRBApprovalNo>
    <Identifier>1</Identifier>
    <MSRequestID>sample string 2</MSRequestID>
    <MajorEventBy>sample string 36</MajorEventBy>
    <MajorEventByID>032b0898-4967-4a52-b179-bcf4ba79972e</MajorEventByID>
    <MajorEventDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </MajorEventDate>
    <MirrorBudgetFields>true</MirrorBudgetFields>
    <Name>sample string 5</Name>
    <Organization>sample string 16</Organization>
    <OrganizationID>519f71a2-4eb1-4ed6-b820-c90179499284</OrganizationID>
    <ParentRequestID>826f2c93-e8c7-4098-adec-e0a3866a2f35</ParentRequestID>
    <PhiDisclosureLevel>sample string 18</PhiDisclosureLevel>
    <Priority>Low</Priority>
    <Project>sample string 4</Project>
    <ProjectID>126e4273-9fb1-4a8c-9e81-64e71c8371f9</ProjectID>
    <PurposeOfUse>sample string 17</PurposeOfUse>
    <Query>sample string 41</Query>
    <ReportAggregationLevel>sample string 19</ReportAggregationLevel>
    <ReportAggregationLevelID>10eb5f46-31cb-4afc-a0f1-404aec9a67c1</ReportAggregationLevelID>
    <RequestType>sample string 25</RequestType>
    <RequestTypeID>b7a0220e-bd04-4377-ac52-8c2d20a3a067</RequestTypeID>
    <RequesterCenter>sample string 29</RequesterCenter>
    <RequesterCenterID>08052fb7-5da7-4568-b0a5-9d9855e638bc</RequesterCenterID>
    <Schedule>sample string 20</Schedule>
    <ScheduleCount>21</ScheduleCount>
    <Scheduled>true</Scheduled>
    <SourceActivityID>9050d315-eb28-4e4e-a6e5-d78d5d5f27de</SourceActivityID>
    <SourceActivityProjectID>36e4bb53-d4a0-441a-a8a5-5afd6375b201</SourceActivityProjectID>
    <SourceTaskOrderID>8194b7aa-45a1-4781-826b-40d61f8b9bbc</SourceTaskOrderID>
    <Status>ThirdPartySubmittedDraft</Status>
    <StatusText>sample string 33</StatusText>
    <SubmittedBy>sample string 23</SubmittedBy>
    <SubmittedByID>6cb32afe-1f11-4610-85c2-1bade8584138</SubmittedByID>
    <SubmittedByName>sample string 22</SubmittedByName>
    <SubmittedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </SubmittedOn>
    <Template>true</Template>
    <UpdatedBy>sample string 10</UpdatedBy>
    <UpdatedByID>6645b1a3-b52d-4472-854f-b74bcb302525</UpdatedByID>
    <UpdatedOn xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2024-05-14T02:09:44.3492104Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes>
    </UpdatedOn>
    <UserIdentifier>sample string 40</UserIdentifier>
    <Workflow>sample string 31</Workflow>
    <WorkflowID>9832c2eb-5d6b-47ae-9668-a4a8bac84bb5</WorkflowID>
    <WorkplanType>sample string 30</WorkplanType>
    <WorkplanTypeID>a9fa56ed-0800-4ff7-99fc-70b6d3d216a2</WorkplanTypeID>
  </Entity>
  <Uri>sample string 1</Uri>
</RequestCompletionResponseDTO>