Method GetProcessesSimple

GetProcessesSimple(String, List<String>, List<String>, GetProcessOptionsContract)

Returns a list of simple process informations

Declaration

GetProcessesSimpleResultContract GetProcessesSimple(string connectionId, List<string> processIds, List<string> resultProperties, GetProcessOptionsContract options)

Parameters

Type	Name	Description
System.String	connectionId	The connection id to identify your connection. See also ConnectionId
System.Collections.Generic.List<System.String>	processIds	List of process ids
System.Collections.Generic.List<System.String>	resultProperties	Optional: List of property type ids which should be returned
GetProcessOptionsContract	options

Returns

Type	Description
GetProcessesSimpleResultContract	Returns an instance of GetProcessesSimpleResultContract that contains a list of ProcessSimpleContract and a list of ServiceExceptionListItemContract. If getting a process fails, a ServiceException is added to the latter list together with the process id (see also ObjectId).

Examples

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

An example that returns a list of simple process informations.

{
   "connectionId": "1786c163-3efb-4efa-8bab-61f136e2b4cc",
   "processIds": [ "3b742069-2cb9-ee11-a53b-00155df08701", "3b742069-2cb9-ee11-a53b-00155df08708", "222831f4-09ba-ee11-a53b-00155df08701" ],
   "resultProperties": [ "01000002-d596-485b-ace6-d64647a94277", "01000001-d596-485b-ace6-d64647a94277",
     "01000a00-38a7-11d8-a902-0050bf427e8f", "01000031-38a7-11d8-a902-0050bf427e8f" ],
   "options": {
     "IgnoreProcessNotFoundException": false,
     "IgnoreNotEnoughRightsException": false }
}

Response:

{
   "GetProcessesSimpleResult": {
     "Exceptions": [{
       "ObjectId": "3b742069-2cb9-ee11-a53b-00155df08708",
       "ServiceException": {
         "ErrorNumber": 10015,
         "Message": "No process found for processId 3b742069-2cb9-ee11-a53b-00155df08708",
         "MessageRawText": "No process found for processId {0}",
         "ReferenceObjects": [],
         "StackTrace": "   at Com.Kendox.Dcis.SubSystem.Service.Adapters.AdapterAbstract.CreateServiceException(Int32 errorNumber, Object[] args, Exception innerException, List`1 referenceObjects)
           ..." } }],
     "ProcessesSimple": [{
       "AccessRightsEnumList": [ "CheckOut", "EditProcess", "Delete", "CancelCheckOut", "DeleteDocumentFromProcess" ],
       "CheckOutStateEnum": "NotCheckedOut",
       "DueDate": "2024-01-22T13:44:00",
       "FolderElementId": null,
       "HasLinks": false,
       "Id": "3b742069-2cb9-ee11-a53b-00155df08701",
       "Name": {
         "Values": [{
           "Culture": "de",
           "Text": "Test1" }, {
           "Culture": "en",
           "Text": "Test1" }] },
       "PriorityEnum": "Normal",
         "Properties": [{
           "GlobalValues": [{
             "Values": [{
               "Culture": "en-US",
               "Text": "DCI administrator" }, {
               "Culture": "en",
               "Text": "DCI administrator" }] }],
           "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
           "Values": [ "0100a003-38a7-11d8-a902-0050bf427e8f" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
           "Values": [ "2024-01-22T13:44:00" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
           "Values": [ "Test1" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000031-38a7-11d8-a902-0050bf427e8f",
           "Values": [ "2024-01-22T13:44:00" ] }],
       "StatusEnum": "Open" }, {
       "AccessRightsEnumList": [ "CheckOut", "EditProcess", "Delete", "CancelCheckOut", "DeleteDocumentFromProcess" ],
       "CheckOutStateEnum": "NotCheckedOut",
       "DueDate": "2024-01-23T16:10:00",
       "FolderElementId": null,
       "HasLinks": true,
       "Id": "222831f4-09ba-ee11-a53b-00155df08701",
       "Name": {
         "Values": [{
           "Culture": "de",
           "Text": "Test1" }, {
           "Culture": "en",
           "Text": "Test1" }] },
       "PriorityEnum": "Normal",
         "Properties": [{
           "GlobalValues": [{
             "Values": [{
               "Culture": "en-US",
               "Text": "DCI administrator" }, {
               "Culture": "en",
               "Text": "DCI administrator" }] }],
           "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
           "Values": [ "0100a003-38a7-11d8-a902-0050bf427e8f" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
           "Values": [ "2024-01-23T16:10:00" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
           "Values": [ "Test1" ] }, {
           "GlobalValues": [],
           "PropertyTypeId": "01000031-38a7-11d8-a902-0050bf427e8f",
           "Values": [ "2024-01-23T16:10:00" ] }],
       "StatusEnum": "Open" }]
   }
}

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	Not enough rights ({accessOperationName}, {accessOperationId}) (10071)
ServiceException	Verification code is needed: Verification code not yet verified (10152)