Method StartProcess

StartProcess(String, ProcessContract, Boolean)

Start a process

Declaration

StartProcessResultContract StartProcess(string connectionId, ProcessContract process, bool assignUsers)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
ProcessContract	process	Process to create
System.Boolean	assignUsers	assign to users

Returns

Type	Description
StartProcessResultContract	Started process

Examples

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

Example for start a process.

{
   "connectionId": "831ff0cd-6a36-4831-ae98-c66f54e8079b",
   "process": {
     "AccessRightsEnumList": ["CheckOut", "EditProcess", "Delete"],
     "CheckOutStateEnum": "CheckedOutExclusive",
     "CheckOutUserId": "0100a003-38a7-11d8-a902-0050bf427e8f",
     "Comments": [],
     "CompletedDate": null,
     "CompletedTasks": [],
     "CreatedDate": "2019-09-25T14:25:30",
     "CurrentTask": null,
     "CustomProperties": [],
     "DocumentIds": ["6ba7a04c-a0df-e911-a949-00155d290a08"],
     "DueDate": "2019-09-27T14:25:28",
     "Id": "ce3fee52-a0df-e911-a949-00155d290a08",
     "Name": {
       "Values": [{
         "Culture": "de",
         "Text": "Rechnungen" }, {
         "Culture": "en",
         "Text": "Invoice" }] },
     "PluginStream": [],
     "PriorityEnum": "Normal",
     "ProcessTemplateId": "24a927d1-21d2-e911-a93c-00155d290a08",
     "Properties": [{                
       "PropertyTypeId": "3ecaf07d-c1cf-e911-a939-00155d290a08",
       "Values": ["12564"] }, {
       "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
       "Values": ["Rechnung"] }, {
       "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
       "Values": ["Invoice"] }, {
       "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
       "Values": ["0100a000-38a7-11d8-a902-0050bf427e8f"] }, {
       "PropertyTypeId": "01000031-38a7-11d8-a902-0050bf427e8f",
       "Values": ["2019-09-27T14:25:00"] }, {
       "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
       "Values": ["0100a003-38a7-11d8-a902-0050bf427e8f"] }, {
       "PropertyTypeId": "01000003-d596-485b-ace6-d64647a94277",
       "Values": ["ce3fee52-a0df-e911-a949-00155d290a08"] }, {
       "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
       "Values": ["2019-09-25T14:25:00"] }, {
       "PropertyTypeId": "0100003d-38a7-11d8-a902-0050bf427e8f",
       "Values": ["24a927d1-21d2-e911-a93c-00155d290a08"] }],
     "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
     "StatusEnum": "Open" },
   "assignUsers": false
}

Response:

{
   "StartProcessResult": {
     "Process": {
       "AccessRightsEnumList": ["CheckOut", "EditProcess", "Delete"],
       "CheckOutStateEnum": "NotCheckedOut",
       "CheckOutUserId": "00000000-0000-0000-0000-000000000000",
       "Comments": [],
       "CompletedDate": null,
       "CompletedTasks": [],
       "CreatedDate": "2019-09-25T14:25:30",
       "CurrentTask": {
         "Action": "Kontieren",
         "AssignedUserIds": [],
         "Comments": [],
         "CompletedDate": null,
         "CompletedUserIds": [],
         "CreatedDate": "2019-09-25T14:25:30",
         "CreatorId": "0100a003-38a7-11d8-a902-0050bf427e8f",
         "Description": "Account assignment",
         "DueDate": "2019-09-28T14:25:30",
         "Id": "4844ee52-a0df-e911-a949-00155d290a08",
         "IntendedUserIds": [],
         "ReminderDate": "2019-09-25T14:25:30",
         "RequiresAllRecipients": false,
         "ShowCloseTaskDialog": false,
         "StatusEnum": "Open",
         "TaskTemplateId": "92b13f55-e7b6-46ec-98b0-034d7ef5a8fe" },
       "CustomProperties": [],
       "DocumentIds": ["6ba7a04c-a0df-e911-a949-00155d290a08"],
       "DueDate": "2019-09-27T14:25:28",
       "Id": "ce3fee52-a0df-e911-a949-00155d290a08",
       "Name": {
         "Values": [{
           "Culture": "de",
           "Text": "Rechnungen" }, {
           "Culture": "en",
           "Text": "Invoice" }] },
       "PluginStream": [],
       "PriorityEnum": "Normal",
       "ProcessTemplateId": "24a927d1-21d2-e911-a93c-00155d290a08",
       "Properties": [{                    
         "PropertyTypeId": "3ecaf07d-c1cf-e911-a939-00155d290a08",
         "Values": ["12564"] }, {
         "PropertyTypeId": "2cdacc4e-15d0-e911-a93a-00155d290a08",
         "Values": ["Rechnung"] }, {
         "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
         "Values": ["Invoice"] }, {
         "PropertyTypeId": "01000000-d596-485b-ace6-d64647a94277",
         "Values": ["0100a000-38a7-11d8-a902-0050bf427e8f"] }, {
         "PropertyTypeId": "01000031-38a7-11d8-a902-0050bf427e8f",
         "Values": ["2019-09-27T14:25:00"] }, {
         "PropertyTypeId": "01000032-38a7-11d8-a902-0050bf427e8f",
         "Values": ["1"] }, {
         "PropertyTypeId": "01000037-38a7-11d8-a902-0050bf427e8f",
         "Values": ["Kontieren"] }, {
         "PropertyTypeId": "01000038-38a7-11d8-a902-0050bf427e8f",
         "Values": ["2019-09-28T14:25:00"] }],
       "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
       "StatusEnum": "Open" },
       "SubjectIdList": [] }
   }

Exceptions

Type	Condition
ServiceException	The connection id {connectionId} isn't valid or has expired (10008)
ServiceException	Unknown data type for property type (10035)
ServiceException	String was not recognized as a valid DateTime: {dateTimeValue}. Expected format {expectedFormat} (10059)
ServiceException	Property type not found {propertyTypeId} (10034)
ServiceException	Verification code is needed: Verification code not yet verified (10152)
ServiceException	Failure while inserting value: '{propertyTypeValue}' into propertyType: {propertyTypeId} (10190)
ServiceException	Property type {propertyTypeId} value is too long: {value} (10179)
ServiceException	Web service is not available {url} (10220)
ServiceException	Webservice failed {soapException} (10221)
ServiceException	User {user.LoginName} can not be assigned to list {assignedUsers} because {user.LoginName} is not in the predefined user list (10259)
ServiceException	User not found {userId} (10047)