Actions

The ballerinax/sap.signavio package exposes the following client:

Available clients:

Client	Purpose
`Client`	Manages SAP Signavio dictionary entries, directories, models, ingestion, transformation manager initiatives/assets/insights/objectives, journey modeler metrics, search, and SIGNAL Engine OData access.

Client

The Client provides access to the SAP Signavio APIs — Process Manager (Dictionary, Directory, Model, Import and Export, Search), Process Intelligence (Ingestion and SIGNAL Engine OData), Process Governance Analytics, Journey Modeler Metrics, and Process Transformation Manager (Initiatives, Assets, Insights, and Objectives). Client.init() exchanges the configured credentials for both an API gateway JWT and a Process Manager workspace session, and holds both for the lifetime of the client.

Configuration

Credentials

SAP Signavio account credentials, passed as the auth field of ConnectionConfig.

Field	Type	Default	Description
`username`	`string`	Required	The account's user name (typically an email address)
`password`	`string`	Required	The account's password
`tenant`	`string`	Optional	Unique identifier of the target workspace. Only necessary if the authenticating user is a member of multiple workspaces
`odataAccessToken`	`string`	Optional	A SAP Signavio OData API access token. Only required to call `getServiceDocument`, `getMetadata`, or `queryEntitySet` — the SIGNAL Engine OData API authenticates with a dedicated access token rather than the account password, so it can't be derived from `username`/`password` automatically

ConnectionConfig

Provides a set of configurations for controlling the behaviours when communicating with the SAP Signavio APIs. Passed as the first argument to the client initializer.

Field	Type	Default	Description
`auth`	`Credentials`	Required	SAP Signavio account credentials
`region`	`string`	`"eu"`	The SAP Signavio region that hosts the workspace. Determines both the API gateway hostname (`api.<region>.signavio.cloud.sap`) and the Process Manager workspace hostname (`app-<region>.signavio.com`)
`httpVersion`	`http:HttpVersion`	`http:HTTP_2_0`	The HTTP version understood by the client
`http1Settings`	`http:ClientHttp1Settings`		Configurations related to HTTP/1.x protocol
`http2Settings`	`http:ClientHttp2Settings`		Configurations related to HTTP/2 protocol
`timeout`	`decimal`	`30`	The maximum time to wait (in seconds) for a response before closing the connection
`forwarded`	`string`	`"disable"`	The choice of setting `forwarded`/`x-forwarded` header
`followRedirects`	`http:FollowRedirects`	Optional	Configurations associated with redirection
`poolConfig`	`http:PoolConfiguration`	Optional	Configurations associated with request pooling
`cache`	`http:CacheConfig`		HTTP caching related configurations
`compression`	`http:Compression`	`http:COMPRESSION_AUTO`	Specifies the way of handling compression (`accept-encoding`) header
`circuitBreaker`	`http:CircuitBreakerConfig`	Optional	Configurations associated with the behaviour of the Circuit Breaker
`retryConfig`	`http:RetryConfig`	Optional	Configurations associated with retrying
`cookieConfig`	`http:CookieConfig`	Optional	Configurations associated with cookies
`responseLimits`	`http:ResponseLimitConfigs`		Configurations associated with inbound response size limits
`secureSocket`	`http:ClientSecureSocket`	Optional	SSL/TLS-related options
`proxy`	`http:ProxyConfig`	Optional	Proxy server related options
`socketConfig`	`http:ClientSocketConfig`		Provides settings related to client socket configuration
`validation`	`boolean`	`true`	Enables the inbound payload validation functionality provided by the constraint package
`laxDataBinding`	`boolean`	`true`	Enables relaxed data binding on the client side, treating `nil` values and absent fields as optional

The client initializer also accepts two optional string parameters:

Parameter	Default	Description
`gatewayUrl`	Derived from `config.region`	URL of the SAP Signavio API gateway
`workspaceUrl`	Derived from `config.region`	URL of the SAP Signavio Process Manager workspace

Initializing the client

import ballerinax/sap.signavio;

configurable string username = ?;
configurable string password = ?;

signavio:Client signavioClient = check new ({auth: {username, password}});

Operations

Analytics (SPG)

listCaseVariables

List of case-variables resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`include`	`string`	No	case-variables relationship to include
`pageOffset`	`int`	No	Page offset
`filterId`	`string`	Yes	Filter by id (csv)

Returns: CaseVariablesResourcesResponseSchema \| CaseVariablesResourceReferencesResponseSchema \| error

Sample code:

CaseVariablesResourcesResponseSchema result = check signavioClient->listCaseVariables();

Sample response:

{
  "data": [
    {
      "attributes": {
        "values": {},
        "name": {},
        "defaultValues": {},
        "description": {},
        "variableId": {},
        "case": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getCaseVariable

Case-variables resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	case-variables relationship to include

Returns: CaseVariablesResourceResponseSchema \| CaseVariablesResourceReferencesResponseSchema \| error

Sample code:

CaseVariablesResourceResponseSchema result = check signavioClient->getCaseVariable(id);

Sample response:

{
  "data": {
    "attributes": {
      "values": {},
      "name": "string",
      "defaultValues": {},
      "description": "string",
      "variableId": "string",
      "case": {
        "id": {}
      }
    },
    "relationships": {},
    "links": {}
  }
}

listCaseVariableCases

Cases related to a case-variables resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	cases relationships to include (csv)

Returns: CasesResourceResponseSchema \| CasesResourceReferencesResponseSchema \| error

Sample code:

CasesResourceResponseSchema result = check signavioClient->listCaseVariableCases(id);

Sample response:

{
  "data": {
    "attributes": {
      "creator": {
        "id": {}
      },
      "variables": [
        {}
      ],
      "milestone": "string",
      "processId": {
        "date": "string",
        "timestamp": 0
      },
      "caseNumber": 0,
      "created": 0,
      "name": "string",
      "closed": 0
    },
    "relationships": {},
    "links": {}
  }
}

listCaseVariableCaseRefs

Cases references related to a case-variables resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	cases relationships to include (csv)

Returns: CasesResourceReferenceResponseSchema \| CasesResourceReferencesResponseSchema \| error

Sample code:

CasesResourceReferenceResponseSchema result = check signavioClient->listCaseVariableCaseRefs(id);

Sample response:

{
  "data": {
    "id": {
      "date": "string",
      "timestamp": 0
    }
  }
}

listCases

List of cases resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`include`	`string`	No	cases relationships to include (csv)
`pageOffset`	`int`	No	Page offset
`filterProcessId`	`string`	No	Filter by processId

Returns: CasesResourcesResponseSchema \| CasesResourceReferencesResponseSchema \| error

Sample code:

CasesResourcesResponseSchema result = check signavioClient->listCases();

Sample response:

{
  "data": [
    {
      "attributes": {
        "creator": {},
        "variables": {},
        "milestone": {},
        "processId": {},
        "caseNumber": {},
        "created": {},
        "name": {},
        "closed": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getCase

Cases resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	cases relationships to include (csv)

Returns: CasesResourceResponseSchema \| error

Sample code:

CasesResourceResponseSchema result = check signavioClient->getCase(id);

Sample response:

{
  "data": {
    "attributes": {
      "creator": {
        "id": {}
      },
      "variables": [
        {}
      ],
      "milestone": "string",
      "processId": {
        "date": "string",
        "timestamp": 0
      },
      "caseNumber": 0,
      "created": 0,
      "name": "string",
      "closed": 0
    },
    "relationships": {},
    "links": {}
  }
}

listCaseTasks

Tasks related to a cases resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`fields`	`string`	No	tasks field to include
`filterId`	`string`	No	Filter by id (csv)

Returns: TasksResourcesResponseSchema \| TasksResourceReferencesResponseSchema \| error

Sample code:

TasksResourcesResponseSchema result = check signavioClient->listCaseTasks(id);

Sample response:

{
  "data": [
    {
      "attributes": {
        "due": {},
        "created": {},
        "name": {},
        "assignee": {},
        "completed": {},
        "updated": {},
        "case": {},
        "applicationLink": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getCaseCreator

Users related to a cases resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`fields`	`string`	No	users fields to include (csv)

Returns: UsersResourceResponseSchema \| UsersResourceReferencesResponseSchema \| error

Sample code:

UsersResourceResponseSchema result = check signavioClient->getCaseCreator(id);

Sample response:

{
  "data": {
    "attributes": {
      "name": "string",
      "email": "string"
    },
    "relationships": {},
    "links": {}
  }
}

listFiles

List of files resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`pageOffset`	`int`	No	Page offset
`filterId`	`string`	No	Filter by id (csv)

Returns: FilesResourcesResponseSchema \| FilesResourceReferencesResponseSchema \| error

Sample code:

FilesResourcesResponseSchema result = check signavioClient->listFiles();

Sample response:

{
  "data": [
    {
      "attributes": {
        "size": {},
        "name": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getFile

Files resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`fields`	`string`	No	files fields to include (csv)

Returns: FilesResourceResponseSchema \| FilesResourceReferencesResponseSchema \| error

Sample code:

FilesResourceResponseSchema result = check signavioClient->getFile(id);

Sample response:

{
  "data": {
    "attributes": {
      "size": 0,
      "name": "string"
    },
    "relationships": {},
    "links": {}
  }
}

listGroups

List of groups resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`include`	`string`	No	groups relationships to include (csv)
`pageOffset`	`int`	No	Page offset
`fields`	`string`	No	groups fields to include (csv)
`filterId`	`string`	No	Filter by id (csv)

Returns: GroupsResourcesResponseSchema \| GroupsResourceReferencesResponseSchema \| error

Sample code:

GroupsResourcesResponseSchema result = check signavioClient->listGroups();

Sample response:

{
  "data": [
    {
      "attributes": {
        "name": {},
        "users": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getGroup

Groups resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	groups relationships to include (csv)
`fields`	`string`	No	groups fields to include (csv)

Returns: GroupsResourceResponseSchema \| GroupsResourceReferencesResponseSchema \| error

Sample code:

GroupsResourceResponseSchema result = check signavioClient->getGroup(id);

Sample response:

{
  "data": {
    "attributes": {
      "name": "string",
      "users": [
        {}
      ]
    },
    "relationships": {},
    "links": {}
  }
}

listGroupUserRefs

Users references related to a groups resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.

Returns: UsersResourceReferencesResponseSchema \| error

Sample code:

UsersResourceReferencesResponseSchema result = check signavioClient->listGroupUserRefs(id);

Sample response:

{
  "data": [
    {
      "id": {
        "date": "string",
        "timestamp": 0
      }
    }
  ]
}

listGroupUsers

Users related to a groups resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`fields`	`string`	No	users fields to include (csv)

Returns: UsersResourcesResponseSchema \| UsersResourceReferencesResponseSchema \| error

Sample code:

UsersResourcesResponseSchema result = check signavioClient->listGroupUsers(id);

Sample response:

{
  "data": [
    {
      "attributes": {
        "name": {},
        "email": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

listTasks

List of tasks resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`include`	`string`	No	tasks relationships to include (csv)
`pageOffset`	`int`	No	Page offset
`filterAssigneeEmail`	`string`	No	Filter by assignee
`filterCaseId`	`string`	No	Filter by case
`filterCompleted`	`string`	No	Filter by completed
`fields`	`string`	No	tasks field to include
`filterId`	`string`	No	Filter by id (csv)

Returns: TasksResourcesResponseSchema \| TasksResourceReferencesResponseSchema \| error

Sample code:

TasksResourcesResponseSchema result = check signavioClient->listTasks();

Sample response:

{
  "data": [
    {
      "attributes": {
        "due": {},
        "created": {},
        "name": {},
        "assignee": {},
        "completed": {},
        "updated": {},
        "case": {},
        "applicationLink": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getTask

Tasks resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`include`	`string`	No	tasks relationships to include (csv)
`fields`	`string`	No	tasks field to include

Returns: TasksResourceResponseSchema \| TasksResourceReferencesResponseSchema \| error

Sample code:

TasksResourceResponseSchema result = check signavioClient->getTask(id);

Sample response:

{
  "data": {
    "attributes": {
      "due": 0,
      "created": 0,
      "name": "string",
      "assignee": {
        "name": "string",
        "email": "string"
      },
      "completed": 0,
      "updated": 0,
      "case": {
        "id": {}
      },
      "applicationLink": "string"
    },
    "relationships": {},
    "links": {}
  }
}

getTaskCase

Case related to a tasks resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.

Returns: CasesResourceResponseSchema \| CasesResourceReferencesResponseSchema \| error

Sample code:

CasesResourceResponseSchema result = check signavioClient->getTaskCase(id);

Sample response:

{
  "data": {
    "attributes": {
      "creator": {
        "id": {}
      },
      "variables": [
        {}
      ],
      "milestone": "string",
      "processId": {
        "date": "string",
        "timestamp": 0
      },
      "caseNumber": 0,
      "created": 0,
      "name": "string",
      "closed": 0
    },
    "relationships": {},
    "links": {}
  }
}

getTaskCaseRef

Case reference related to a tasks resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.

Returns: CasesResourceReferenceResponseSchema \| CasesResourceReferencesResponseSchema \| error

Sample code:

CasesResourceReferenceResponseSchema result = check signavioClient->getTaskCaseRef(id);

Sample response:

{
  "data": {
    "id": {
      "date": "string",
      "timestamp": 0
    }
  }
}

listUsers

List of users resources

Parameters:

Name	Type	Required	Description
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`pageLimit`	`int`	No	Max number of items
`pageOffset`	`int`	No	Page offset
`filterId`	`string`	No	Filter by id (csv)

Returns: UsersResourcesResponseSchema \| UsersResourceReferencesResponseSchema \| error

Sample code:

UsersResourcesResponseSchema result = check signavioClient->listUsers();

Sample response:

{
  "data": [
    {
      "attributes": {
        "name": {},
        "email": {}
      },
      "relationships": {},
      "links": {}
    }
  ]
}

getUser

Users resource

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	case primary key to include
`contentType`	`"application/vnd.api+json"\|"application/json"`	No	The content type of the request. Use `application/vnd.api+json`.
`fields`	`string`	No	users fields to include (csv)

Returns: UsersResourceResponseSchema \| UsersResourceReferencesResponseSchema \| error

Sample code:

UsersResourceResponseSchema result = check signavioClient->getUser(id);

Sample response:

{
  "data": {
    "attributes": {
      "name": "string",
      "email": "string"
    },
    "relationships": {},
    "links": {}
  }
}

Journey Modeler Metrics

addAutomaticMeasurementToMetric

Add automatic measurement to existing metrics.

Parameters:

Name	Type	Required	Description
`journeyId`	`string`	Yes	The ID of the journey to be updated
`metricId`	`string`	Yes	The ID of the metric to be updated
`payload`	`AutomaticMeasurement`	Yes	Request payload (AutomaticMeasurement)

Returns: error?

Sample code:

error? result = check signavioClient->addAutomaticMeasurementToMetric(journeyId, metricId, payload);

Authentication

authenticate

Create an API access token (login)

Parameters:

Name	Type	Required	Description
`payload`	`TokenRequest`	Yes	Request payload (TokenRequest)
`contentType`	`string`	No	Required request body format

Returns: string \| error

Sample code:

string result = check signavioClient->authenticate(payload);

Sample response:

"string"

Dictionary

listDictionaryEntries

Lists dictionary entries, optionally filtered by category, and with full-text search or title initial letter filter.

Parameters:

Name	Type	Required	Description
`contentType`	`string`	No	application/x-www-form-urlencoded
`q`	`string`	No	Filters by a full-text search term (ignored when `letter` is specified)
`include`	`string`	No	If set to `all`, dictionary entries from a category and its subcategories are listed
`offset`	`int`	No	The number of entries to skip before returning entries. Useful in combination with `limit` for pagination
`letter`	`string`	No	Filters by the initial letter of the dictionary entry's title
`sort`	`string`	No	If set to `title`, sorts entries by title; otherwise, the search sorts results by a dynamically determined relevance score
`category`	`string`	No	Filters by entry type - `ORG_UNIT`, `DOCUMENT`, `ACTIVITY`, `STATE`, or `IT_SYSTEM`, representing the pre-defined dictionary categories "Organizational Units", "Documents", "Activities", "Events", and "IT Systems", respectively, or a Dictionary category's ID

Returns: DictionaryResponse[] \| error

Sample code:

DictionaryResponse[] result = check signavioClient->listDictionaryEntries();

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {}
  }
]

createDictionaryEntry

Creates a dictionary entry.

Parameters:

Name	Type	Required	Description
`payload`	`DictionaryEntryRequest`	Yes	Request payload (DictionaryEntryRequest)

Returns: DictionaryResponse \| error

Sample code:

DictionaryResponse result = check signavioClient->createDictionaryEntry(payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {}
}

getDictionaryEntry

Retrieves the specified dictionary entry.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary entry to retrieve

Returns: DictionaryResponse[] \| error

Sample code:

DictionaryResponse[] result = check signavioClient->getDictionaryEntry(id);

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {}
  }
]

deleteDictionaryEntry

Deletes a dictionary entry.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary entry to delete

Returns: SuccessResponse \| error

Sample code:

SuccessResponse result = check signavioClient->deleteDictionaryEntry(id);

Sample response:

{
  "success": true
}

getDictionaryEntryInfo

Retrieves the specified dictionary entry with additional meta information: most importantly, the category containing the entry.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary entry to retrieve

Returns: Representation \| error

Sample code:

Representation result = check signavioClient->getDictionaryEntryInfo(id);

Sample response:

{
  "formats": {},
  "attachments": [
    {}
  ],
  "color": "string",
  "hidden": true,
  "grantedRevisionUser": "string",
  "workflowSyncUpToDate": true,
  "publishingMode": "string",
  "grantedRevisionUserName": "string"
}

updateDictionaryEntry

Updates a dictionary entry.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary entry to update
`payload`	`DictionaryEntryUpdateRequest`	Yes	Request payload (DictionaryEntryUpdateRequest)

Returns: DictionaryResponse \| error

Sample code:

DictionaryResponse result = check signavioClient->updateDictionaryEntry(id, payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {}
}

listDictionaryCategories

Retrieves a list of your workspace's dictionary categories.

Parameters:

Name	Type	Required	Description
`showHidden`	`boolean`	No	If set to `true`, hidden categories are included in the response
`allCategories`	`boolean`	No	If set to `true`, all categories' representations are returned at once, without the need to send additional queries for sub-categories
`considerAllPrivilege`	`boolean`	No	To circumvent access restrictions as a member of the workspace's administrators group, set this parameter to true

Returns: DictionaryResponse[] \| error

Sample code:

DictionaryResponse[] result = check signavioClient->listDictionaryCategories();

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {}
  }
]

createDictionaryCategory

Creates a dictionary category.

Parameters:

Name	Type	Required	Description
`payload`	`DictionaryCategoryRequest`	Yes	Request payload (DictionaryCategoryRequest)
`contentType`	`string`	No	application/x-www-form-urlencoded

Returns: DictionaryResponse \| error

Sample code:

DictionaryResponse result = check signavioClient->createDictionaryCategory(payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {}
}

getDictionaryCategory

Retrieves the specified dictionary category.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary category to retrieve

Returns: DictionaryResponse[] \| error

Sample code:

DictionaryResponse[] result = check signavioClient->getDictionaryCategory(id);

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {}
  }
]

updateDictionaryCategory

Updates an existing dictionary category.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the dictionary category to update
`payload`	`DictionaryCategoryRequest`	Yes	Request payload (DictionaryCategoryRequest)
`contentType`	`string`	No	application/x-www-form-urlencoded

Returns: DictionaryResponse \| error

Sample code:

DictionaryResponse result = check signavioClient->updateDictionaryCategory(id, payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {}
}

deleteDictionaryCategory

Deletes a dictionary category.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The dictionary category to delete
`moveContent`	`boolean`	Yes	If set to `true`, before deleting the category with all its sub-categories, the content is moved to the 'Others' category. Otherwise, sub-categories and all contained dictionary entries and the sub-categories' contained dictionary entries will be deleted

Returns: SuccessResponse \| error

Sample code:

SuccessResponse result = check signavioClient->deleteDictionaryCategory(id);

Sample response:

{
  "success": true
}

Name	Type	Required	Description
`payload`	`CreateDirectoryRequest`	Yes	Request payload (CreateDirectoryRequest)

Name	Type	Required	Description
`id`	`DirectoryId`	Yes	The ID of the directory to get the content of

Name	Type	Required	Description
`id`	`DirectoryId`	Yes	The ID of the directory to move
`payload`	`MoveDirectoryRequest`	Yes	Request payload (MoveDirectoryRequest)

Name	Type	Required	Description
`id`	`DirectoryId`	Yes	The ID of the directory to delete

Name	Type	Required	Description
`id`	`DirectoryId`	Yes	The ID of the directory to get the meta-data of

Name	Type	Required	Description
`id`	`DirectoryId`	Yes	The ID of the directory to rename
`payload`	`RenameDirectoryData`	Yes	Request payload (RenameDirectoryData)

Name	Type	Required	Description
`payload`	`PublishData`	Yes	Request payload (PublishData)

Model Export and Import

getModelJson

Get the model diagram as JSON

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The ID of the model to be retrieved

Returns: DiagramJson \| error

Sample code:

DiagramJson result = check signavioClient->getModelJson(modelId);

Sample response:

{
  "resourceId": "string",
  "properties": {},
  "childShapes": [
    {
      "resourceId": "string",
      "properties": {}
    }
  ]
}

getRevisionJson

Get revision JSON.

Parameters:

Name	Type	Required	Description
`revisionId`	`string`	Yes	The ID of the revision to be retrieved

Returns: DiagramJson \| error

Sample code:

DiagramJson result = check signavioClient->getRevisionJson(revisionId);

Sample response:

{
  "resourceId": "string",
  "properties": {},
  "childShapes": [
    {
      "resourceId": "string",
      "properties": {}
    }
  ]
}

getPng

Get the model diagram as a PNG image

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The ID of the model

Returns: byte[] \| error

Sample code:

byte[] result = check signavioClient->getPng(modelId);

getRevisionPng

Get revision PNG.

Parameters:

Name	Type	Required	Description
`revisionId`	`string`	Yes	Revision ID

Returns: byte[] \| error

Sample code:

byte[] result = check signavioClient->getRevisionPng(revisionId);

getBpmnXml

Get BPMN 2.0 XML

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The ID of the model
`exportSubprocesses`	`boolean`	No	Whether to include linked subprocesses
`language`	`string`	No	Which tenant content language to use as the primary language of the exported XML

Returns: xml \| error

Sample code:

xml result = check signavioClient->getBpmnXml(modelId);

getRevisionBpmnXml

Get revision BPMN 2.0 XML

Parameters:

Name	Type	Required	Description
`revisionId`	`string`	Yes	The ID of the model revision
`exportSubprocesses`	`boolean`	No	Whether to include linked subprocesses
`language`	`string`	No	Which tenant content language to use as the primary language of the exported XML

Returns: xml \| error

Sample code:

xml result = check signavioClient->getRevisionBpmnXml(revisionId);

getSvg

Get the model diagram as an SVG image

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The ID of the model

Returns: http:Response \| error

Sample code:

http:Response result = check signavioClient->getSvg(modelId);

getRevisionSvg

Get revision SVG.

Parameters:

Name	Type	Required	Description
`revisionId`	`string`	Yes	Revision ID

Returns: http:Response \| error

Sample code:

http:Response result = check signavioClient->getRevisionSvg(revisionId);

importBpmn20Xml

Import BPMN 2.0 XML

Parameters:

Name	Type	Required	Description
`payload`	`BpmnImportRequest`	Yes	Request payload (BpmnImportRequest)

Returns: BpmnImportResult \| error

Sample code:

BpmnImportResult result = check signavioClient->importBpmn20Xml(payload);

Sample response:

{
  "numUpdated": 0,
  "createdIds": [
    "string"
  ],
  "warnings": [
    {
      "details": [
        {}
      ]
    }
  ],
  "mainModelId": "string",
  "numCreated": 0,
  "updatedIds": [
    "string"
  ],
  "errors": [
    {
      "details": [
        {}
      ]
    }
  ]
}

getDmnDownloadLink

Retrieve download link to xml

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the model

Returns: DmnDownloadLinkResponse \| error

Sample code:

DmnDownloadLinkResponse result = check signavioClient->getDmnDownloadLink(id);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {
    "success": true,
    "downloadUrl": "string",
    "messages": [
      "string"
    ]
  }
}

downloadDmnXml

Download DMN XML

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The download id provided from /dmn-xml-download/{id}

Returns: byte[] \| error

Sample code:

byte[] result = check signavioClient->downloadDmnXml(id);

Ingestion

uploadSchemaAndData

Upload schema and data

Parameters:

Name	Type	Required	Description
`payload`	`IngestionDataRequest`	Yes	Request payload (IngestionDataRequest)

Returns: UploadSchemaAndDataResponseDto \| error

Sample code:

UploadSchemaAndDataResponseDto result = check signavioClient->uploadSchemaAndData(payload);

Sample response:

{
  "executionId": "string"
}

getStatus

Get status of ingestion request

Parameters:

Name	Type	Required	Description
`executionId`	`string`	Yes	Ingestion request execution Id

Returns: ExecutionStatusDto \| error

Sample code:

ExecutionStatusDto result = check signavioClient->getStatus(executionId);

Sample response:

{
  "displayStatus": "string",
  "message": "string",
  "status": "REQUEST_VALIDATING\"|\"REQUEST_VALIDATED\"|\"REQUEST_VALIDATION_FAILED\"|\"FILE_CONVERTING\"|\"FILE_CONVERTED\"|\"FILE_CONVERSION_FAILED\"|\"FILE_UPLOADING\"|\"FILE_UPLOADED\"|\"FILE_UPLOAD_FAILED\"|\"INTERNAL_SYNCHRONISING\"|\"INTERNAL_SYNCHRONISING_FAILED\"|\"COMPLETED"
}

Transformation Manager - Initiatives

listInitiatives

List initiatives

Parameters:

Name	Type	Required	Description
`search`	`string`	No	Full-text search query for initiative name and description. Minimum 3 characters required; shorter queries are ignored
`pageNumber`	`int:Signed32`	No	Page number (1-based, the first page has number 1)
`nameContains`	`string`	No	Only list initiatives that contain this substring. This parameter can be repeated
`valueDriver`	`ValueDriver`	No	Only list initiatives containing this value driver. This parameter can be repeated
`createdBy`	`UUID`	No	Only list initiatives which were created by this user. This parameter can be repeated
`authorizationRole`	`Role`	No	Only list initiatives where the user has the specified access role. This parameter can be repeated
`sortOrder`	`"Ascending"\|"Descending"`	No	Order to sort the initiatives by
`hasMember`	`UUID`	No	Only list initiatives which this user is a member. This parameter can be repeated
`pageSize`	`int:Signed32`	No	Number of entries per page
`sortBy`	`"dateCreated"\|"dateUpdated"\|"name"\|"startDate"\|"endDate"\|"lastActivity"\|"numberOfInsights"`	No	Initiative property to sort by
`status`	`InitiativeStatus`	No	Only list initiatives with this status. This parameter can be repeated

Returns: Initiative[] \| error

Sample code:

Initiative[] result = check signavioClient->listInitiatives();

Sample response:

[
  {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sri": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  }
]

createInitiative

Create initiative

Parameters:

Name	Type	Required	Description
`payload`	`IncomingInitiative`	Yes	Request payload (IncomingInitiative)

Returns: Initiative \| error

Sample code:

Initiative result = check signavioClient->createInitiative(payload);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "endDate": "string",
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "sri": "string",
  "dateUpdated": "string",
  "dateCreated": "string"
}

getInitiative

Get initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	The id of the initiative to retrieve

Returns: Initiative \| error

Sample code:

Initiative result = check signavioClient->getInitiative(initiativeId);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "endDate": "string",
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "sri": "string",
  "dateUpdated": "string",
  "dateCreated": "string"
}

updateInitiative

Update initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	The id of the initiative to update
`payload`	`IncomingInitiative`	Yes	Request payload (IncomingInitiative)

Returns: Initiative \| error

Sample code:

Initiative result = check signavioClient->updateInitiative(initiativeId, payload);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "endDate": "string",
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "sri": "string",
  "dateUpdated": "string",
  "dateCreated": "string"
}

deleteInitiative

Delete initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	The id of the initiative to delete

Returns: error?

Sample code:

error? result = check signavioClient->deleteInitiative(initiativeId);

Transformation Manager - Assets

listAssetsInitiative

List assets from initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	The id of the initiative containing the assets

Returns: Asset[] \| error

Sample code:

Asset[] result = check signavioClient->listAssetsInitiative(initiativeId);

Sample response:

[
  {
    "initiative": {
      "updatedBy": {
        "firstName": "string",
        "lastName": "string",
        "displayName": "string",
        "id": {},
        "userGroupIds": [
          {}
        ],
        "email": "string"
      },
      "endDate": "string",
      "valueDrivers": [
        {}
      ],
      "authorizations": [
        {}
      ],
      "description": "string",
      "sri": "string",
      "dateUpdated": "string",
      "dateCreated": "string"
    },
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "dateCreated": "string",
    "createdBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "name": "string",
    "description": "string",
    "id": "string",
    "url": "string"
  }
]

createAssetInitiative

Create asset in initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	The id of the initiative to add the asset to
`payload`	`IncomingAsset`	Yes	Request payload (IncomingAsset)

Returns: Asset \| error

Sample code:

Asset result = check signavioClient->createAssetInitiative(initiativeId, payload);

Sample response:

{
  "initiative": {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sri": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  },
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "dateCreated": "string",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "name": "string",
  "description": "string",
  "id": "string",
  "url": "string"
}

getAssetInitiative

Get asset from initiative

Parameters:

Name	Type	Required	Description
`assetId`	`UUID`	Yes	The id of the asset to retrieve
`initiativeId`	`UUID`	Yes	The id of the initiative containing the asset

Returns: Asset \| error

Sample code:

Asset result = check signavioClient->getAssetInitiative(assetId, initiativeId);

Sample response:

{
  "initiative": {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sri": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  },
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "dateCreated": "string",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "name": "string",
  "description": "string",
  "id": "string",
  "url": "string"
}

updateAssetInitiative

Update asset in initiative

Parameters:

Name	Type	Required	Description
`assetId`	`UUID`	Yes	The id of the asset to update
`initiativeId`	`UUID`	Yes	The id of the initiative containing the asset
`payload`	`IncomingAsset`	Yes	Request payload (IncomingAsset)

Returns: Asset \| error

Sample code:

Asset result = check signavioClient->updateAssetInitiative(assetId, initiativeId, payload);

Sample response:

{
  "initiative": {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sri": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  },
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "dateCreated": "string",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "name": "string",
  "description": "string",
  "id": "string",
  "url": "string"
}

deleteAssetInitiative

Delete asset from initiative

Parameters:

Name	Type	Required	Description
`assetId`	`UUID`	Yes	The id of the asset to delete
`initiativeId`	`UUID`	Yes	The id of the initiative containing the asset

Returns: Asset \| error

Sample code:

Asset result = check signavioClient->deleteAssetInitiative(assetId, initiativeId);

Sample response:

{
  "initiative": {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sri": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  },
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "dateCreated": "string",
  "createdBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "name": "string",
  "description": "string",
  "id": "string",
  "url": "string"
}

Transformation Manager - Insights

listInsightsInInitiative

Get all insights in an initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`string`	Yes	ID of the initiative whose insights should be listed
`pageNumber`	`int:Signed32`	No	Page number (1-based, the first page has number 1)
`nameContains`	`string`	No	Only list insights that contain this substring. This parameter can be repeated
`processIntelligenceCanvasType`	`"INVESTIGATION"\|"DASHBOARD"`	No	Only list insights containing discoveries from process intelligence with this canvas type. This parameter can be repeated
`valueDriver`	"IT_CAPACITY_PLANNING"\|"IMPROVE_DEMAND_FORECAST_ACCURACY"\|"IMPROVE_ON_TIME_DELIVERY"\|"IMPROVE_FTE_PRODUCTIVITY"\|"IMPROVE_USER_COMPLIANCE"\|"INCREASE_CASH_FORECAST_ACCURACY"\|"INCREASE_DAYS_PAYABLES"\|"INCREASE_EFFECTIVENESS_MARKETING"\|"OPERATIONAL_EXCELLENCE"\|"REDUCE_HR_MANUAL_TRANSACTION"\|"REDUCE_ASSET_COST"\|"REDUCE_CUSTOMER_CHURN"\|"REDUCE_DATA_MANAGEMENT_COST"\|"REDUCE_DAYS_IN_INVENTORY"\|"REDUCE_DAYS_SALES"\|"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS"\|"REDUCE_FINANCE_COST"\|"REDUCE_MANUFACTURING_CYCLE_TIME"\|"REDUCE_READING_TO_INVOICE_TIME"\|"REDUCE_NON_COMPLIANT_SERVICES"\|"REDUCE_SUPPLY_CHAIN_PLANNING_COST"\|"REDUCE_REVENUE_LOSS"\|"REDUCE_SALES_COSTS"\|"REDUCE_SERVICE_SUPPORT_COST"\|"REDUCE_TIME_TO_FILL"\|"REDUCE_TIME_TO_MARKET"\|"REDUCE_LOGISTICS_COST"\|"REDUCE_MANUFACTURING_COSTS"\|"REDUCE_UNPLANNED_DOWNTIME"\|"REDUCE_UNCOLLECTIBLE_ACCOUNTS"	No	Only list insights containing this value driver. This parameter can be repeated
`discoveryReferenceApplication`	`"PROCESS_MANAGER"\|"PROCESS_INTELLIGENCE"\|"PROCESS_INSIGHTS"\|"BENCHMARKING_ANALYTICS"\|"JOURNEY_MODELER"\|"SUITE_CAPABILITIES"\|"PROCESS_GOVERNANCE"`	No	Only list insights containing discoveries with this domain application. This parameter can be repeated
`processInsightsProcessFlowId`	`string`	No	Only list insights containing discoveries from process insights with this process flow id. This parameter can be repeated
`pageSize`	`int:Signed32`	No	Number of entries per page
`processIntelligenceWidgetId`	`string`	No	Only list insights containing discoveries from process intelligence with this widget id. This parameter can be repeated
`processIntelligenceProcessId`	`string`	No	Only list insights containing discoveries from process intelligence with this process id. This parameter can be repeated
`createdBy`	`string`	No	Only list insights which were created by this user. This parameter can be repeated
`processInsightsSystemId`	`string`	No	Only list insights containing discoveries from process insights with this system id. This parameter can be repeated
`sortOrder`	`"Ascending"\|"Descending"`	No	Order to sort the initiatives by
`processIntelligenceCanvasId`	`string`	No	Only list insights containing discoveries from process intelligence with this canvas id. This parameter can be repeated
`sortBy`	`"dateCreated"\|"dateUpdated"\|"name"\|"impactScore"\|"effortScore"\|"priorityScore"`	No	Initiative property to sort by
`tag`	`string`	No	Only list insights which contain this tag. This parameter can be repeated
`assignee`	`string`	No	Only list insights which are assigned to this user. This parameter can be repeated
`discoveryReferenceSRI`	`string`	No	Only list insights containing discoveries with this SRI. This parameter can be repeated
`status`	`"OPEN"\|"IN_PROGRESS"\|"RESOLVED"`	No	Only list insights with this status. This parameter can be repeated

Returns: Insight[] \| error

Sample code:

Insight[] result = check signavioClient->listInsightsInInitiative(initiativeId);

Sample response:

[
  {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "assignees": [
      {
        "firstName": "string",
        "lastName": "string",
        "displayName": "string",
        "id": {},
        "userGroupIds": [
          {}
        ],
        "email": "string"
      }
    ],
    "sri": "string",
    "dateUpdated": "string",
    "tags": [
      {
        "dateCreated": {},
        "id": {},
        "label": "string",
        "dateUpdated": {}
      }
    ]
  }
]

getInsightInInitiative

Get insight in initiative

Parameters:

Name	Type	Required	Description
`initiativeId`	`UUID`	Yes	ID of the initiative to which the insight belongs
`insightId`	`UUID`	Yes	ID of the insight to be retrieved

Returns: Insight \| error

Sample code:

Insight result = check signavioClient->getInsightInInitiative(initiativeId, insightId);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "assignees": [
    {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    }
  ],
  "sri": "string",
  "dateUpdated": "string",
  "tags": [
    {
      "dateCreated": "string",
      "id": "string",
      "label": "string",
      "dateUpdated": "string"
    }
  ]
}

listInsights

Get all insights

Parameters:

Name	Type	Required	Description
`pageNumber`	`int:Signed32`	No	Page number (1-based, the first page has number 1)
`nameContains`	`string`	No	Only list insights that contain this substring. This parameter can be repeated
`processIntelligenceCanvasType`	`"INVESTIGATION"\|"DASHBOARD"`	No	Only list insights containing discoveries from process intelligence with this canvas type. This parameter can be repeated
`valueDriver`	"IT_CAPACITY_PLANNING"\|"IMPROVE_DEMAND_FORECAST_ACCURACY"\|"IMPROVE_ON_TIME_DELIVERY"\|"IMPROVE_FTE_PRODUCTIVITY"\|"IMPROVE_USER_COMPLIANCE"\|"INCREASE_CASH_FORECAST_ACCURACY"\|"INCREASE_DAYS_PAYABLES"\|"INCREASE_EFFECTIVENESS_MARKETING"\|"OPERATIONAL_EXCELLENCE"\|"REDUCE_HR_MANUAL_TRANSACTION"\|"REDUCE_ASSET_COST"\|"REDUCE_CUSTOMER_CHURN"\|"REDUCE_DATA_MANAGEMENT_COST"\|"REDUCE_DAYS_IN_INVENTORY"\|"REDUCE_DAYS_SALES"\|"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS"\|"REDUCE_FINANCE_COST"\|"REDUCE_MANUFACTURING_CYCLE_TIME"\|"REDUCE_READING_TO_INVOICE_TIME"\|"REDUCE_NON_COMPLIANT_SERVICES"\|"REDUCE_SUPPLY_CHAIN_PLANNING_COST"\|"REDUCE_REVENUE_LOSS"\|"REDUCE_SALES_COSTS"\|"REDUCE_SERVICE_SUPPORT_COST"\|"REDUCE_TIME_TO_FILL"\|"REDUCE_TIME_TO_MARKET"\|"REDUCE_LOGISTICS_COST"\|"REDUCE_MANUFACTURING_COSTS"\|"REDUCE_UNPLANNED_DOWNTIME"\|"REDUCE_UNCOLLECTIBLE_ACCOUNTS"	No	Only list insights containing this value driver. This parameter can be repeated
`discoveryReferenceApplication`	`"PROCESS_MANAGER"\|"PROCESS_INTELLIGENCE"\|"PROCESS_INSIGHTS"\|"BENCHMARKING_ANALYTICS"\|"JOURNEY_MODELER"\|"SUITE_CAPABILITIES"\|"PROCESS_GOVERNANCE"`	No	Only list insights containing discoveries with this domain application. This parameter can be repeated
`processInsightsProcessFlowId`	`string`	No	Only list insights containing discoveries from process insights with this process flow id. This parameter can be repeated
`pageSize`	`int:Signed32`	No	Number of entries per page
`processIntelligenceWidgetId`	`string`	No	Only list insights containing discoveries from process intelligence with this widget id. This parameter can be repeated
`processIntelligenceProcessId`	`string`	No	Only list insights containing discoveries from process intelligence with this process id. This parameter can be repeated
`createdBy`	`string`	No	Only list insights which were created by this user. This parameter can be repeated
`processInsightsSystemId`	`string`	No	Only list insights containing discoveries from process insights with this system id. This parameter can be repeated
`sortOrder`	`"Ascending"\|"Descending"`	No	Order to sort the initiatives by
`processIntelligenceCanvasId`	`string`	No	Only list insights containing discoveries from process intelligence with this canvas id. This parameter can be repeated
`sortBy`	`"dateCreated"\|"dateUpdated"\|"name"\|"impactScore"\|"effortScore"\|"priorityScore"`	No	Initiative property to sort by
`tag`	`string`	No	Only list insights which contain this tag. This parameter can be repeated
`assignee`	`string`	No	Only list insights which are assigned to this user. This parameter can be repeated
`discoveryReferenceSRI`	`string`	No	Only list insights containing discoveries with this SRI. This parameter can be repeated
`status`	`"OPEN"\|"IN_PROGRESS"\|"RESOLVED"`	No	Only list insights with this status. This parameter can be repeated

Returns: Insight[] \| error

Sample code:

Insight[] result = check signavioClient->listInsights();

Sample response:

[
  {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "assignees": [
      {
        "firstName": "string",
        "lastName": "string",
        "displayName": "string",
        "id": {},
        "userGroupIds": [
          {}
        ],
        "email": "string"
      }
    ],
    "sri": "string",
    "dateUpdated": "string",
    "tags": [
      {
        "dateCreated": {},
        "id": {},
        "label": "string",
        "dateUpdated": {}
      }
    ]
  }
]

createInsight

Create an insight

Parameters:

Name	Type	Required	Description
`payload`	`IncomingInsight`	Yes	Request payload (IncomingInsight)

Returns: Insight \| error

Sample code:

Insight result = check signavioClient->createInsight(payload);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "assignees": [
    {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    }
  ],
  "sri": "string",
  "dateUpdated": "string",
  "tags": [
    {
      "dateCreated": "string",
      "id": "string",
      "label": "string",
      "dateUpdated": "string"
    }
  ]
}

getInsight

Get insight

Parameters:

Name	Type	Required	Description
`insightId`	`UUID`	Yes	The id of the insight to retrieve

Returns: Insight \| error

Sample code:

Insight result = check signavioClient->getInsight(insightId);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "assignees": [
    {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    }
  ],
  "sri": "string",
  "dateUpdated": "string",
  "tags": [
    {
      "dateCreated": "string",
      "id": "string",
      "label": "string",
      "dateUpdated": "string"
    }
  ]
}

updateInsight

Update insight

Parameters:

Name	Type	Required	Description
`insightId`	`UUID`	Yes	The id of the insight to update
`payload`	`IncomingInsight`	Yes	Request payload (IncomingInsight)

Returns: Insight \| error

Sample code:

Insight result = check signavioClient->updateInsight(insightId, payload);

Sample response:

{
  "updatedBy": {
    "firstName": "string",
    "lastName": "string",
    "displayName": "string",
    "id": "string",
    "userGroupIds": [
      "string"
    ],
    "email": "string"
  },
  "valueDrivers": [
    "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS"
  ],
  "authorizations": [
    {
      "role": "OWNER\"|\"EDITOR\"|\"VIEWER",
      "targetType": "USER\"|\"GROUP",
      "target": {
        "displayName": "string",
        "id": {}
      }
    }
  ],
  "description": "string",
  "assignees": [
    {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    }
  ],
  "sri": "string",
  "dateUpdated": "string",
  "tags": [
    {
      "dateCreated": "string",
      "id": "string",
      "label": "string",
      "dateUpdated": "string"
    }
  ]
}

deleteInsight

Delete insight

Parameters:

Name	Type	Required	Description
`insightId`	`UUID`	Yes	The id of the insight to delete

Returns: json \| error

Sample code:

json result = check signavioClient->deleteInsight(insightId);

Sample response:

{}

Model

retrieveModel

Retrieve Model

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the model to be retrieved

Returns: ModelResourceResponse[] \| error

Sample code:

ModelResourceResponse[] result = check signavioClient->retrieveModel(id);

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {
      "allowedMimeTypeRegex": "string",
      "deleted": true,
      "visible": true,
      "created": "string",
      "name": "string",
      "description": "string",
      "sendingInterval": "string",
      "nameEn": "string"
    }
  }
]

updateModel

Update Model

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the model to be updated
`payload`	`ModelRequest`	Yes	Request payload (ModelRequest)
`dc`	`string`	No	A timestamp or unique string used to prevent caching issues

Returns: ModelResourceResponse[] \| error

Sample code:

ModelResourceResponse[] result = check signavioClient->updateModel(id, payload);

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {
      "allowedMimeTypeRegex": "string",
      "deleted": true,
      "visible": true,
      "created": "string",
      "name": "string",
      "description": "string",
      "sendingInterval": "string",
      "nameEn": "string"
    }
  }
]

deleteModel

Delete Model

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	The ID of the model to be deleted

Returns: SuccessResponse \| error

Sample code:

SuccessResponse result = check signavioClient->deleteModel(id);

Sample response:

{
  "success": true
}

createModel

Create a new Model

Parameters:

Name	Type	Required	Description
`payload`	`ModelRequest`	Yes	Request payload (ModelRequest)
`dc`	`string`	No	A timestamp or unique string used to prevent caching issues

Returns: ModelResponse \| error

Sample code:

ModelResponse result = check signavioClient->createModel(payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {
    "parent": "string",
    "formats": {},
    "grantedRevisionUser": "string",
    "isLicensedStencilSet": true,
    "grantedRevisionUserName": "string",
    "description": "string",
    "sriRevision": "string",
    "sriPath": "string"
  }
}

listModelRevisions

Retrieving all revision IDs of a model.

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The model's ID
`offset`	`int:Signed32`	No	The offset of the first revision to be returned
`query`	`string`	No	A search query to filter the revisions

Returns: ModelRevisionsResponse[] \| error

Sample code:

ModelRevisionsResponse[] result = check signavioClient->listModelRevisions(modelId);

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {
      "rev": 0,
      "size": 0,
      "author": "string",
      "authorName": "string",
      "created": "string",
      "isDeployed": true,
      "comment": "string",
      "authorCompany": "string"
    }
  }
]

updateModelInfo

Update model info

Parameters:

Name	Type	Required	Description
`modelId`	`string`	Yes	The ID of the model
`payload`	`ModelInfoRequest`	Yes	Request payload (ModelInfoRequest)

Returns: ModelInfoResponse \| error

Sample code:

ModelInfoResponse result = check signavioClient->updateModelInfo(modelId, payload);

Sample response:

{
  "parent": "string",
  "formats": {},
  "grantedRevisionUser": "string",
  "isLicensedStencilSet": true,
  "grantedRevisionUserName": "string",
  "description": "string",
  "sriRevision": "string",
  "sriPath": "string"
}

checkSyntax

Performs a syntax check on a BPMN 2.0 process model.

Parameters:

Name	Type	Required	Description
`payload`	`SyntaxCheckRequest`	Yes	Request payload (SyntaxCheckRequest)

Returns: SyntaxCheckResponse \| error

Sample code:

SyntaxCheckResponse result = check signavioClient->checkSyntax(payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": [
    {
      "should": {},
      "must": {},
      "guidelineId": "string"
    }
  ]
}

getExpirationDate

Retrieve the current approval expiration date.

Parameters:

Name	Type	Required	Description
`modelID`	`string`	Yes	The ID of the model

Returns: ExpirationDate \| error

Sample code:

ExpirationDate result = check signavioClient->getExpirationDate(modelID);

Sample response:

{
  "reApprovalDate": "string"
}

updateExpirationDate

Update the approval expiration date.

Parameters:

Name	Type	Required	Description
`modelID`	`string`	Yes	The ID of the model
`payload`	`ExpirationDate`	Yes	Request payload (ExpirationDate)

Returns: ExpirationDate \| error

Sample code:

ExpirationDate result = check signavioClient->updateExpirationDate(modelID, payload);

Sample response:

{
  "reApprovalDate": "string"
}

createExpirationDate

Create a new approval expiration date.

Parameters:

Name	Type	Required	Description
`modelID`	`string`	Yes	The ID of the model
`payload`	`ExpirationDate`	Yes	Request payload (ExpirationDate)

Returns: ExpirationDate \| error

Sample code:

ExpirationDate result = check signavioClient->createExpirationDate(modelID, payload);

Sample response:

{
  "reApprovalDate": "string"
}

deleteExpirationDate

Delete the current approval expiration date.

Parameters:

Name	Type	Required	Description
`modelID`	`string`	Yes	The ID of the model

Returns: error?

Sample code:

error? result = check signavioClient->deleteExpirationDate(modelID);

Editor and Meta

createDiagramDraft

Create a new model draft.

Parameters:

Name	Type	Required	Description
`stencilset`	`string`	Yes	The notation URI value for the stencil set

Returns: DiagramDraftResponse \| error

Sample code:

DiagramDraftResponse result = check signavioClient->createDiagramDraft();

Sample response:

{
  "id": "string"
}

getMetaInfo

Get meta information

Returns: MetaResponseItem[] \| error?

Sample code:

MetaResponseItem[] result = check signavioClient->getMetaInfo();

Sample response:

[
  {
    "rel": "string",
    "href": "string",
    "rep": {
      "glossaryBindings": [
        {}
      ],
      "lineWrap": true,
      "defaultValue": "string",
      "length": 0,
      "description": "string",
      "isGlossaryDefinition": true,
      "nameEnGb": "string",
      "isList": true
    }
  }
]

createMetaInfo

Create meta information

Parameters:

Name	Type	Required	Description
`payload`	`MetaInfoRequest`	Yes	Request payload (MetaInfoRequest)

Returns: MetaResponseItem \| error

Sample code:

MetaResponseItem result = check signavioClient->createMetaInfo(payload);

Sample response:

{
  "rel": "string",
  "href": "string",
  "rep": {
    "glossaryBindings": [
      {}
    ],
    "lineWrap": true,
    "defaultValue": "string",
    "length": 0,
    "description": "string",
    "isGlossaryDefinition": true,
    "nameEnGb": "string",
    "isList": true
  }
}

Objectives

listObjectives

Get all objectives

Parameters:

Name	Type	Required	Description
`size`	`int:Signed32`	No	Page size (max 1000)
`page`	`int:Signed32`	No	Zero-based page index (0 = first page)
`dollarCount`	`boolean`	No	Include approximate total count in response when true

Returns: ObjectivesResponse \| error

Sample code:

ObjectivesResponse result = check signavioClient->listObjectives();

Sample response:

{
  "count": 0,
  "value": [
    {
      "dateCreated": "string",
      "name": "string",
      "description": "string",
      "attributes": [
        {}
      ],
      "sId": "string",
      "dateUpdated": "string"
    }
  ]
}

getObjective

Get objective by SID

Parameters:

Name	Type	Required	Description
`objectiveSid`	`string`	Yes	The Suite Objective ID (SID) (e.g. `SuiteObjective_<32 hex chars>`)

Returns: Objective \| error

Sample code:

Objective result = check signavioClient->getObjective(objectiveSid);

Sample response:

{
  "dateCreated": "string",
  "name": "string",
  "description": "string",
  "attributes": [
    {}
  ],
  "sId": "string",
  "dateUpdated": "string"
}

getInitiativesByObjective

Get linked initiatives

Parameters:

Name	Type	Required	Description
`objectiveSid`	`string`	Yes	The Suite Objective ID (SID) (e.g. `SuiteObjective_<32 hex chars>`)

Returns: InitiativeSummaryForObjective[] \| error

Sample code:

InitiativeSummaryForObjective[] result = check signavioClient->getInitiativesByObjective(objectiveSid);

Sample response:

[
  {
    "updatedBy": {
      "firstName": "string",
      "lastName": "string",
      "displayName": "string",
      "id": "string",
      "userGroupIds": [
        {}
      ],
      "email": "string"
    },
    "endDate": "string",
    "valueDrivers": [
      "IT_CAPACITY_PLANNING\"|\"IMPROVE_DEMAND_FORECAST_ACCURACY\"|\"IMPROVE_ON_TIME_DELIVERY\"|\"IMPROVE_FTE_PRODUCTIVITY\"|\"IMPROVE_USER_COMPLIANCE\"|\"INCREASE_CASH_FORECAST_ACCURACY\"|\"INCREASE_DAYS_PAYABLES\"|\"INCREASE_EFFECTIVENESS_MARKETING\"|\"OPERATIONAL_EXCELLENCE\"|\"REDUCE_HR_MANUAL_TRANSACTION\"|\"REDUCE_ASSET_COST\"|\"REDUCE_CUSTOMER_CHURN\"|\"REDUCE_DATA_MANAGEMENT_COST\"|\"REDUCE_DAYS_IN_INVENTORY\"|\"REDUCE_DAYS_SALES\"|\"REDUCE_DAYS_CLOSE_ANNUAL_BOOKS\"|\"REDUCE_FINANCE_COST\"|\"REDUCE_MANUFACTURING_CYCLE_TIME\"|\"REDUCE_READING_TO_INVOICE_TIME\"|\"REDUCE_NON_COMPLIANT_SERVICES\"|\"REDUCE_SUPPLY_CHAIN_PLANNING_COST\"|\"REDUCE_REVENUE_LOSS\"|\"REDUCE_SALES_COSTS\"|\"REDUCE_SERVICE_SUPPORT_COST\"|\"REDUCE_TIME_TO_FILL\"|\"REDUCE_TIME_TO_MARKET\"|\"REDUCE_LOGISTICS_COST\"|\"REDUCE_MANUFACTURING_COSTS\"|\"REDUCE_UNPLANNED_DOWNTIME\"|\"REDUCE_UNCOLLECTIBLE_ACCOUNTS\"|\"REDUCE_EMISSIONS_COST\"|\"REDUCE_WASTE_GENERATION_COST\"|\"REDUCE_COMPLIANCE_AND_RISK_MANAGEMENT_COST\"|\"INCREASE_BUSINESS_PROCESS_HARMONIZATION\"|\"INCREASE_ADHERENCE_TO_STANDARDIZED_SAP_BUSINESS_PROCESSES"
    ],
    "authorizations": [
      {
        "role": {},
        "targetType": {},
        "target": {}
      }
    ],
    "description": "string",
    "sid": "string",
    "dateUpdated": "string",
    "dateCreated": "string"
  }
]

Search

Search the workspace

Parameters:

Name	Type	Required	Description
`q`	`string`	Yes	The search term
`types`	`string`	No	List of content types the search should include, from `MODEL`, `MODEL_REVISION`, `SHAPE`, `FILE`, `FILE_REVISION`, `DIR` and `COMMENT`
`offset`	`string`	No	Index of first search result to return
`contentmode`	`string`	No	e.g. explorer
`fieldsJson`	`string`	No	Example: `[{"id":"search.searchableFields.all","textQueries":[{"matching":"contains","text":"foo-bar"}]}]`

Returns: http:Response \| error

Sample code:

http:Response result = check signavioClient->search();

SIGNAL Engine OData

getServiceDocument

Returns all entity sets (Odata views) the user has access to. A JSON list is returned representing the entity set.

Returns: ServiceDocument \| error

Sample code:

ServiceDocument result = check signavioClient->getServiceDocument();

Sample response:

{
  "atOdataContext": "string",
  "value": [
    {
      "kind": "string",
      "name": "string",
      "url": "string"
    }
  ]
}

getMetadata

Returns metadata for all entity sets (OData views) the user has access to. An XML schema is returned representing the metadata.

Returns: xml \| error

Sample code:

xml result = check signavioClient->getMetadata();

queryEntitySet

This endpoint implements an OData service endpoint according to version 4.0 of

Parameters:

Name	Type	Required	Description
`entitySetName`	`string`	Yes	The name for the entity set (in this case, the oData view). Can be returned by calling the /$metadata endpoint
`dollarDeltatoken`	`string`	No	Not implemented
`dollarTop`	`int`	No	A positive integer value that specifies the maximum number of entries to return, reduced by the value of skiptoken
`dollarFilter`	`string`	No	A filter expression that all entries in the result set must match
`dollarSkiptoken`	`string`	No	An opaque value that enables consistent pagination of results. Included in the value of the `@odata.nextLink` parameter of a paginated OData result response
`dollarOrderby`	`string`	No	Not implemented
`dollarSearch`	`string`	No	Not implemented
`dollarExpand`	`string`	No	Not implemented
`skip`	`int`	No	A positive integer value that specifies the number of entries to skip before returning the remainder
`dollarFormat`	`string`	No	Requested response format from the client. If specified, `$format` overrides any value specified in the `Accept` header, based on the OData specification 4.0. Currently only `application/json` is supported
`dollarCount`	`boolean`	No	System query option `inlinecount`. If specified, then the server will return the number of entries as an integer
`dollarId`	`string`	No	Not implemented
`dollarSelect`	`string[]`	Yes	The list of properties that each returned entry will specify

Returns: OdataOutput \| error

Sample code:

OdataOutput result = check signavioClient->queryEntitySet(entitySetName);

Sample response:

{
  "atOdataNextLink": "string",
  "atOdataCount": 0,
  "atOdataContext": "string",
  "value": [
    {}
  ]
}

Client​

Configuration​

Credentials​

ConnectionConfig​

Initializing the client​

Operations​

Analytics (SPG)​

Journey Modeler Metrics​

Authentication​

Dictionary​

Directory​

Model Export and Import​

Ingestion​

Transformation Manager - Initiatives​

Transformation Manager - Assets​

Transformation Manager - Insights​

Model​

Editor and Meta​

Objectives​

Search​

SIGNAL Engine OData​

Client

Configuration

Credentials

ConnectionConfig

Initializing the client

Operations

Analytics (SPG)

Journey Modeler Metrics

Authentication

Dictionary

Directory

Model Export and Import

Ingestion

Transformation Manager - Initiatives

Transformation Manager - Assets

Transformation Manager - Insights

Model

Editor and Meta

Objectives

Search

SIGNAL Engine OData