Method CheckOutProcess

CheckOutProcess(String, String)

Start reservation on a process

Declaration

ProcessContract CheckOutProcess(string connectionId, string processId)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.String	processId	The process id. See also Id

Returns

Type	Description
ProcessContract	Checked out process

Examples

POST http://YourServerName/InfoShare/Json/Process/CheckOutProcess

Example for start reservation on a process.

{
   "connectionId": "1fbe116a-20a9-4378-b198-6cf3283f0238",
   "processId": "f407d99d-2cd2-e911-a93c-00155d290a08"
}

Response:

{
   "GetProcessResult": {
     "AccessRightsEnumList": ["EditProcess", "Delete"],
     "CheckOutStateEnum": "NotCheckedOut",
     "CheckOutUserId": "00000000-0000-0000-0000-000000000000",
     "Comments": [],
     "CompletedDate": "2019-09-08T11:38:27",
     "CompletedTasks": [{
       "Action": "Kontieren",
       "AssignedUserIds": [],
       "Comments": [],
       "CompletedDate": "2019-09-08T11:35:05",
       "CompletedUserIds": ["0100a003-38a7-11d8-a902-0050bf427e8f"],
       "CreatedDate": "2019-09-08T11:34:29",
       "CreatorId": "2cd4ad99-bacf-e911-a939-00155d290a08",
       "Description": "Account assignment",
       "DueDate": "2019-09-11T11:34:29",
       "Id": "450dd99d-2cd2-e911-a93c-00155d290a08",
       "IntendedUserIds": [],
       "ReminderDate": "2019-09-08T11:34:29",
       "RequiresAllRecipients": false,
       "ShowCloseTaskDialog": false,
       "StatusEnum": "Complete",
       "TaskTemplateId": "92b13f55-e7b6-46ec-98b0-034d7ef5a8fe" 
       }, {
       "Action": "Kontieren",
       "AssignedUserIds": [],
       "Comments": [],
       "CompletedDate": "2019-09-08T11:35:33",
       "CompletedUserIds": ["2cd4ad99-bacf-e911-a939-00155d290a08"],
       "CreatedDate": "2019-09-08T11:35:05",
       "CreatorId": "0100a003-38a7-11d8-a902-0050bf427e8f",
       "Description": "Account assignment",
       "DueDate": "2019-09-11T11:34:00",
       "Id": "29bba3b3-2cd2-e911-a93c-00155d290a08",
       "IntendedUserIds": [],
       "ReminderDate": "2019-09-08T11:35:05",
       "RequiresAllRecipients": false,
       "ShowCloseTaskDialog": false,
       "StatusEnum": "Complete",
       "TaskTemplateId": "92b13f55-e7b6-46ec-98b0-034d7ef5a8fe" 
       }, {
       "Action": "Finanz",
       "AssignedUserIds": ["0100a003-38a7-11d8-a902-0050bf427e8f"],
       "Comments": [],
       "CompletedDate": "2019-09-08T11:37:36",
       "CompletedUserIds": ["2cd4ad99-bacf-e911-a939-00155d290a08"],
       "CreatedDate": "2019-09-08T11:35:33",
       "CreatorId": "2cd4ad99-bacf-e911-a939-00155d290a08",
       "Description": "Release by finance department",
       "DueDate": "2019-09-09T11:35:33",
       "Id": "871599c1-2cd2-e911-a93c-00155d290a08",
       "IntendedUserIds": [],
       "ReminderDate": "2019-09-08T11:35:33",
       "RequiresAllRecipients": false,
       "ShowCloseTaskDialog": false,
       "StatusEnum": "Complete",
       "TaskTemplateId": "a303e6f6-2c5c-42a8-bdb2-071cb928ae56"
       }, {
       "Action": "Complete process",
       "AssignedUserIds": [],
       "Comments": [],
       "CompletedDate": "2019-09-08T11:38:26",
       "CompletedUserIds": ["2cd4ad99-bacf-e911-a939-00155d290a08"],
       "CreatedDate": "2019-09-08T11:37:48",
       "CreatorId": "2cd4ad99-bacf-e911-a939-00155d290a08",
       "Description": "",
       "DueDate": "2019-09-10T11:34:09",
       "Id": "e88f0515-2dd2-e911-a93c-00155d290a08",
       "IntendedUserIds": [],
       "ReminderDate": "2019-09-08T11:37:48",
       "RequiresAllRecipients": false,
       "ShowCloseTaskDialog": false,
       "StatusEnum": "Complete",
       "TaskTemplateId": "735b676a-4748-4f7a-a994-9ad0de6af0e8" }],
     "CreatedDate": "2019-09-08T11:34:29",
     "CurrentTask": {
       "Action": "Complete process",
       "AssignedUserIds": [],
        "Comments": [],
        "CompletedDate": "2019-09-08T11:38:26",
        "CompletedUserIds": ["2cd4ad99-bacf-e911-a939-00155d290a08"],
        "CreatedDate": "2019-09-08T11:37:48",
        "CreatorId": "2cd4ad99-bacf-e911-a939-00155d290a08",
        "Description": "",
        "DueDate": "2019-09-10T11:34:09",
        "Id": "e88f0515-2dd2-e911-a93c-00155d290a08",
        "IntendedUserIds": [],
        "ReminderDate": "2019-09-08T11:37:48",
        "RequiresAllRecipients": false,
        "ShowCloseTaskDialog": false,
        "StatusEnum": "Complete",
        "TaskTemplateId": "735b676a-4748-4f7a-a994-9ad0de6af0e8" },
      "CustomProperties": [{
        "CustomPropertyTypeEnum": "String",
        "Name": "Bemerkung",
        "Value": "keine Hinweise!" }],
      "DocumentIds": ["a7d3a990-2cd2-e911-a93c-00155d290a08"],
      "DueDate": "2019-09-10T11:34:09",
      "Id": "f407d99d-2cd2-e911-a93c-00155d290a08",
      "Name": {
        "Values": [{
          "Culture": "de",
          "Text": "Rechnungen" }, {
          "Culture": "en",
          "Text": "Invoice" }] },
      "PluginStream": [],
      "PriorityEnum": "High",
      "ProcessTemplateId": "24a927d1-21d2-e911-a93c-00155d290a08",
      "Properties": [{
        "PropertyTypeId": "760fa49a-c1cf-e911-a939-00155d290a08",
        "Values": ["Lizenzenrechnung"] }, {
        "PropertyTypeId": "3ecaf07d-c1cf-e911-a939-00155d290a08",
        "Values": ["7894"] }, {
        "PropertyTypeId": "0086153f-c1cf-e911-a939-00155d290a08",
        "Values": ["390.99"] }, {
        "PropertyTypeId": "b76783b1-c1cf-e911-a939-00155d290a08",
        "Values": ["Entschädigung der Pendlerzeitung"] }, {
        "PropertyTypeId": "69a14957-17d0-e911-a93a-00155d290a08",
        "Values": ["Solothurn"] }, {
        "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
        "Values": ["Rechnung"] }, {
        "PropertyTypeId": "01004001-38a7-11d8-a902-0050bf427e8f",
        "Values": ["MySubject"] }, {
        "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
        "Values": ["2cd4ad99-bacf-e911-a939-00155d290a08"] }, {
        "PropertyTypeId": "01000003-d596-485b-ace6-d64647a94277",
        "Values": ["f407d99d-2cd2-e911-a93c-00155d290a08"] }, {
        "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
        "Values": ["2019-09-08T11:34:00"] }, {
        "PropertyTypeId": "0100003d-38a7-11d8-a902-0050bf427e8f",
        "Values": ["24a927d1-21d2-e911-a93c-00155d290a08"] }, {
        "PropertyTypeId": "0100003e-38a7-11d8-a902-0050bf427e8f",
        "Values": [] }],
      "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
      "StatusEnum": "Complete" }
}

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	No process found for processId {processId} (10015)
ServiceException	Unknown data type for property type (10035)
ServiceException	Verification code is needed: Verification code not yet verified (10152)