Get process model information GET /Processes
Get metadata and information for process models. Image, referencing information such as governing documents, URL links and more.
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
GET | Ticket | /Processes | List available process models | (Start(int)) (Max(int)) | Totalcount (int) Data (array): Id (string) Name (string) Description (string) Official (bool) CreatedDate (date) PublishedDate (date) ChangedDate (date) Category (string) On error: Empty array |
GET | Ticket | /Processes/{Id} | Get metadata for a process model. | Id (string) (VersionId (string)) | Object: Id (string) Name (string) Description (string) Official (bool) AnyOfficial (bool) CreatedDate (date) CreatedBy (string) CreatedByUserId (string) PublishedDate (date) PublishedBy (string) PublishedByUserId (string) ChangedDate (date) ChangedBy (string) ChangedByUserId (string) Category (string) CurrentOfficialObjectVersionId CurrentRevisionObjectVersionId LastVersionComment (string) |
GET | Ticket | /Processes/{Id}/Image | Get the image rendition for a process model If the parameter width is sent in the request, the image height constraint size is intact. If the parameter viewStyle is sent the API will return the process in the specific perspective. Available perspectives are: flow, model and configure | Id (string) (viewStyle (string)) (VersionId (string)) (ZoomFactor (float)) (Width (int)) (Height (int)) | Binary data: PNG image |
GET | Ticket | /Processes/{Id}/ImageAreas | Gets all interactive areas for a process model image If the parameter viewStyle is sent the API will return the process in the specific perspective. Available perspectives are: flow, model and configure | Id (string) (viewStyle (string)) (VersionId (string)) (ZoomFactor (float)) | Object: ImageAreas collection |
GET | Ticket | /Processes/{Id}/ImageAreas/ {containerId} | Gets all references stored in a container image area. The containerId can be found in the ObjectReferenceID property of the imagearea when the imagearea has the objectclassnamespace “container”. If the API cannot figure out FileType it will return the value "unknownFile". | Id (string) containerId (string) | TotalCount (int) Data (array of reference objects): ReferenceType (string) Name (string) FileType (string) (URL (string)) (ObjectReference (object)) On error: If no references are available then an empty array is returned. |