Module sap.signavio

ballerinax/sap.signavio Ballerina library

1.0.0

Overview

SAP Signavio is SAP's business process transformation suite for modeling, analyzing, and improving business processes. The ballerinax/sap.signavio connector provides a unified Ballerina client for the SAP Signavio REST APIs, covering Authentication, 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). The connector is generated from a merged OpenAPI 3.0 specification of the SAP Signavio API.

Setup guide

To use the SAP Signavio connector, you need an SAP Signavio workspace account (a username/email and password).

Sign in to your SAP Signavio workspace and note the region of your tenant (au, ca, eu, jp, kr, sgp, or us) — it determines the hostnames the connector connects to (e.g. api.eu.signavio.cloud.sap and app-eu.signavio.com).

Provide your credentials to the connector via a Config.toml file:


username = "<your-signavio-username-or-email>"
password = "<your-signavio-password>"

Quickstart

To use the sap.signavio connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module


import ballerinax/sap.signavio;

Step 2: Instantiate a new connector


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

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

Step 3: Invoke the connector operation


public function main() returns error? {
    // List the root folders of the workspace
    signavio:HyperMediaObject[] rootFolders = check signavioClient->getRootDirectories();
}

Step 4: Run the Ballerina application


bal run

Examples

The SAP Signavio connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Process model export — Browses the workspace folders and exports a process model as diagram JSON and BPMN 2.0 XML.
Dictionary entry management — Creates a dictionary entry, lists the entries of its category, and retrieves the entry's details.
Business process extraction — Signs in to a Process Manager workspace and collects the Business Process Level 2 and Level 3 models for a downstream Ardoq mapping step.

Clients

sap.signavio: Client

Isolated

The ballerinax/sap.signavio client. Wraps the generated oas client and adds transparent re-authentication: when a request comes back unauthenticated (the gateway JWT is valid ~24h and the Process Manager workspace session has its own server-side timeout), the client re-logs in once and replays the request, so a long-lived client instance keeps working without manual re-initialization.

Constructor

Gets invoked to initialize the connector. Exchanges config.auth for a gateway JWT and a Process Manager workspace session; both are refreshed automatically when they expire.

init (ConnectionConfig config, string? gatewayUrl, string? workspaceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

gatewayUrl string? () - URL of the SAP Signavio API gateway. Defaults to the URL derived from config.region

workspaceUrl string? () - URL of the SAP Signavio Process Manager workspace. Defaults to the URL derived from config.region

listCaseVariables

Isolated FunctionRemote Function

function listCaseVariables(ListCaseVariablesHeaders headers, *ListCaseVariablesQueries queries) returns CaseVariablesResourcesResponseSchema|CaseVariablesResourceReferencesResponseSchema|error

List of case-variables resources

Parameters

headers ListCaseVariablesHeaders (default {}) - Headers to be sent with the request

queries *ListCaseVariablesQueries - Queries to be sent with the request

Return Type

CaseVariablesResourcesResponseSchema|CaseVariablesResourceReferencesResponseSchema|error - The returned case variables resources response schema

getCaseVariable

Isolated FunctionRemote Function

function getCaseVariable(string id, GetCaseVariableHeaders headers, *GetCaseVariableQueries queries) returns CaseVariablesResourceResponseSchema|CaseVariablesResourceReferencesResponseSchema|error

Case-variables resource

Parameters

id string - case primary key to include

headers GetCaseVariableHeaders (default {}) - Headers to be sent with the request

queries *GetCaseVariableQueries - Queries to be sent with the request

Return Type

CaseVariablesResourceResponseSchema|CaseVariablesResourceReferencesResponseSchema|error - The returned case variables resource response schema

listCaseVariableCases

Isolated FunctionRemote Function

function listCaseVariableCases(string id, ListCaseVariableCasesHeaders headers, *ListCaseVariableCasesQueries queries) returns CasesResourceResponseSchema|CasesResourceReferencesResponseSchema|error

Cases related to a case-variables resource

Parameters

id string - case primary key to include

headers ListCaseVariableCasesHeaders (default {}) - Headers to be sent with the request

queries *ListCaseVariableCasesQueries - Queries to be sent with the request

Return Type

CasesResourceResponseSchema|CasesResourceReferencesResponseSchema|error - The returned cases resource response schema

listCaseVariableCaseRefs

Isolated FunctionRemote Function

function listCaseVariableCaseRefs(string id, ListCaseVariableCaseRefsHeaders headers, *ListCaseVariableCaseRefsQueries queries) returns CasesResourceReferenceResponseSchema|CasesResourceReferencesResponseSchema|error

Cases references related to a case-variables resource

Parameters

id string - case primary key to include

headers ListCaseVariableCaseRefsHeaders (default {}) - Headers to be sent with the request

queries *ListCaseVariableCaseRefsQueries - Queries to be sent with the request

Return Type

CasesResourceReferenceResponseSchema|CasesResourceReferencesResponseSchema|error - The returned cases resource reference response schema

listCases

Isolated FunctionRemote Function

function listCases(ListCasesHeaders headers, *ListCasesQueries queries) returns CasesResourcesResponseSchema|CasesResourceReferencesResponseSchema|error

List of cases resources

Parameters

headers ListCasesHeaders (default {}) - Headers to be sent with the request

queries *ListCasesQueries - Queries to be sent with the request

Return Type

CasesResourcesResponseSchema|CasesResourceReferencesResponseSchema|error - The returned cases resources response schema

getCase

Isolated FunctionRemote Function

function getCase(string id, GetCaseHeaders headers, *GetCaseQueries queries) returns CasesResourceResponseSchema|error

Cases resource

Parameters

id string - case primary key to include

headers GetCaseHeaders (default {}) - Headers to be sent with the request

queries *GetCaseQueries - Queries to be sent with the request

Return Type

CasesResourceResponseSchema|error - The returned cases resource response schema

listCaseTasks

Isolated FunctionRemote Function

function listCaseTasks(string id, ListCaseTasksHeaders headers, *ListCaseTasksQueries queries) returns TasksResourcesResponseSchema|TasksResourceReferencesResponseSchema|error

Tasks related to a cases resource

Parameters

id string - case primary key to include

headers ListCaseTasksHeaders (default {}) - Headers to be sent with the request

queries *ListCaseTasksQueries - Queries to be sent with the request

Return Type

TasksResourcesResponseSchema|TasksResourceReferencesResponseSchema|error - The returned tasks resources response schema

getCaseCreator

Isolated FunctionRemote Function

function getCaseCreator(string id, GetCaseCreatorHeaders headers, *GetCaseCreatorQueries queries) returns UsersResourceResponseSchema|UsersResourceReferencesResponseSchema|error

Users related to a cases resource

Parameters

id string - case primary key to include

headers GetCaseCreatorHeaders (default {}) - Headers to be sent with the request

queries *GetCaseCreatorQueries - Queries to be sent with the request

Return Type

UsersResourceResponseSchema|UsersResourceReferencesResponseSchema|error - The returned users resource response schema

listFiles

Isolated FunctionRemote Function

function listFiles(ListFilesHeaders headers, *ListFilesQueries queries) returns FilesResourcesResponseSchema|FilesResourceReferencesResponseSchema|error

List of files resources

Parameters

headers ListFilesHeaders (default {}) - Headers to be sent with the request

queries *ListFilesQueries - Queries to be sent with the request

Return Type

FilesResourcesResponseSchema|FilesResourceReferencesResponseSchema|error - The returned files resources response schema

getFile

Isolated FunctionRemote Function

function getFile(string id, GetFileHeaders headers, *GetFileQueries queries) returns FilesResourceResponseSchema|FilesResourceReferencesResponseSchema|error

Files resource

Parameters

id string - case primary key to include

headers GetFileHeaders (default {}) - Headers to be sent with the request

queries *GetFileQueries - Queries to be sent with the request

Return Type

FilesResourceResponseSchema|FilesResourceReferencesResponseSchema|error - The returned files resource response schema

listGroups

Isolated FunctionRemote Function

function listGroups(ListGroupsHeaders headers, *ListGroupsQueries queries) returns GroupsResourcesResponseSchema|GroupsResourceReferencesResponseSchema|error

List of groups resources

Parameters

headers ListGroupsHeaders (default {}) - Headers to be sent with the request

queries *ListGroupsQueries - Queries to be sent with the request

Return Type

GroupsResourcesResponseSchema|GroupsResourceReferencesResponseSchema|error - The returned groups resources response schema

getGroup

Isolated FunctionRemote Function

function getGroup(string id, GetGroupHeaders headers, *GetGroupQueries queries) returns GroupsResourceResponseSchema|GroupsResourceReferencesResponseSchema|error

Groups resource

Parameters

id string - case primary key to include

headers GetGroupHeaders (default {}) - Headers to be sent with the request

queries *GetGroupQueries - Queries to be sent with the request

Return Type

GroupsResourceResponseSchema|GroupsResourceReferencesResponseSchema|error - The returned groups resource response schema

listGroupUserRefs

Isolated FunctionRemote Function

function listGroupUserRefs(string id, ListGroupUserRefsHeaders headers) returns UsersResourceReferencesResponseSchema|error

Users references related to a groups resource

Parameters

id string - case primary key to include

headers ListGroupUserRefsHeaders (default {}) - Headers to be sent with the request

Return Type

UsersResourceReferencesResponseSchema|error - The returned users resource references response schema

listGroupUsers

Isolated FunctionRemote Function

function listGroupUsers(string id, ListGroupUsersHeaders headers, *ListGroupUsersQueries queries) returns UsersResourcesResponseSchema|UsersResourceReferencesResponseSchema|error

Users related to a groups resource

Parameters

id string - case primary key to include

headers ListGroupUsersHeaders (default {}) - Headers to be sent with the request

queries *ListGroupUsersQueries - Queries to be sent with the request

Return Type

UsersResourcesResponseSchema|UsersResourceReferencesResponseSchema|error - The returned users resources response schema

listTasks

Isolated FunctionRemote Function

function listTasks(ListTasksHeaders headers, *ListTasksQueries queries) returns TasksResourcesResponseSchema|TasksResourceReferencesResponseSchema|error

List of tasks resources

Parameters

headers ListTasksHeaders (default {}) - Headers to be sent with the request

queries *ListTasksQueries - Queries to be sent with the request

Return Type

TasksResourcesResponseSchema|TasksResourceReferencesResponseSchema|error - The returned tasks resources response schema

getTask

Isolated FunctionRemote Function

function getTask(string id, GetTaskHeaders headers, *GetTaskQueries queries) returns TasksResourceResponseSchema|TasksResourceReferencesResponseSchema|error

Tasks resource

Parameters

id string - case primary key to include

headers GetTaskHeaders (default {}) - Headers to be sent with the request

queries *GetTaskQueries - Queries to be sent with the request

Return Type

TasksResourceResponseSchema|TasksResourceReferencesResponseSchema|error - The returned tasks resource response schema

getTaskCase

Isolated FunctionRemote Function

function getTaskCase(string id, GetTaskCaseHeaders headers, *GetTaskCaseQueries queries) returns CasesResourceResponseSchema|CasesResourceReferencesResponseSchema|error

Case related to a tasks resource

Parameters

id string - case primary key to include

headers GetTaskCaseHeaders (default {}) - Headers to be sent with the request

queries *GetTaskCaseQueries - Queries to be sent with the request

Return Type

CasesResourceResponseSchema|CasesResourceReferencesResponseSchema|error - The returned cases resource response schema

getTaskCaseRef

Isolated FunctionRemote Function

function getTaskCaseRef(string id, GetTaskCaseRefHeaders headers) returns CasesResourceReferenceResponseSchema|CasesResourceReferencesResponseSchema|error

Case reference related to a tasks resource

Parameters

id string - case primary key to include

headers GetTaskCaseRefHeaders (default {}) - Headers to be sent with the request

Return Type

CasesResourceReferenceResponseSchema|CasesResourceReferencesResponseSchema|error - The returned cases resource reference response schema

listUsers

Isolated FunctionRemote Function

function listUsers(ListUsersHeaders headers, *ListUsersQueries queries) returns UsersResourcesResponseSchema|UsersResourceReferencesResponseSchema|error

List of users resources

Parameters

headers ListUsersHeaders (default {}) - Headers to be sent with the request

queries *ListUsersQueries - Queries to be sent with the request

Return Type

UsersResourcesResponseSchema|UsersResourceReferencesResponseSchema|error - The returned users resources response schema

getUser

Isolated FunctionRemote Function

function getUser(string id, GetUserHeaders headers, *GetUserQueries queries) returns UsersResourceResponseSchema|UsersResourceReferencesResponseSchema|error

Users resource

Parameters

id string - case primary key to include

headers GetUserHeaders (default {}) - Headers to be sent with the request

queries *GetUserQueries - Queries to be sent with the request

Return Type

UsersResourceResponseSchema|UsersResourceReferencesResponseSchema|error - The returned users resource response schema

addAutomaticMeasurementToMetric

Isolated FunctionRemote Function

function addAutomaticMeasurementToMetric(string journeyId, string metricId, AutomaticMeasurement payload, map<string|string[]> headers) returns error?

Add automatic measurement to existing metrics.

Parameters

journeyId string - The ID of the journey to be updated

metricId string - The ID of the metric to be updated

payload AutomaticMeasurement - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Updated successfully

authenticate

Isolated FunctionRemote Function

function authenticate(TokenRequest payload, AuthenticateHeaders headers) returns string|error

Create an API access token (login)

Parameters

payload TokenRequest - The request payload

headers AuthenticateHeaders (default {}) - Headers to be sent with the request

Return Type

string|error - Authentication successful. Following successful authentication, subsequent authenticated API requests must include the 'JSESSIONID' cookie

listDictionaryEntries

Isolated FunctionRemote Function

function listDictionaryEntries(ListDictionaryEntriesHeaders headers, *ListDictionaryEntriesQueries queries) returns DictionaryResponse[]|error

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

Parameters

headers ListDictionaryEntriesHeaders (default {}) - Headers to be sent with the request

queries *ListDictionaryEntriesQueries - Queries to be sent with the request

Return Type

DictionaryResponse[]|error - A JSON representation of the search results. All dictionary entries are contained in a top-level array (bounded by [ and ]), and contain the key-value pair "rel": "gitem" (for 'glossary item'). The important fields inside the content of their rep object have the same semantics as is defined for dictionary entry creation. They are: * id * title * category * description * attachments Some fields provide additional information on the entry's category: * categoryName * color Hint: If the category ID in the category query string is not found, the response includes all categories instead of having a 404 Not Found status

createDictionaryEntry

Isolated FunctionRemote Function

function createDictionaryEntry(DictionaryEntryRequest payload, CreateDictionaryEntryHeaders headers) returns DictionaryResponse|error

Creates a dictionary entry.

Parameters

payload DictionaryEntryRequest - The request payload

headers CreateDictionaryEntryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse|error - Returns a JSON object containing the created dictionary item

getDictionaryEntry

Isolated FunctionRemote Function

function getDictionaryEntry(string id, GetDictionaryEntryHeaders headers) returns DictionaryResponse[]|error

Retrieves the specified dictionary entry.

Parameters

id string - The ID of the dictionary entry to retrieve

headers GetDictionaryEntryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse[]|error - The returned dictionary response list

deleteDictionaryEntry

Isolated FunctionRemote Function

function deleteDictionaryEntry(string id, DeleteDictionaryEntryHeaders headers) returns SuccessResponse|error

Deletes a dictionary entry.

Parameters

id string - The ID of the dictionary entry to delete

headers DeleteDictionaryEntryHeaders (default {}) - Headers to be sent with the request

Return Type

SuccessResponse|error - The returned success response

getDictionaryEntryInfo

Isolated FunctionRemote Function

function getDictionaryEntryInfo(string id, GetDictionaryEntryInfoHeaders headers) returns Representation|error

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

Parameters

id string - The ID of the dictionary entry to retrieve

headers GetDictionaryEntryInfoHeaders (default {}) - Headers to be sent with the request

Return Type

Representation|error - The returned representation

updateDictionaryEntry

Isolated FunctionRemote Function

function updateDictionaryEntry(string id, DictionaryEntryUpdateRequest payload, UpdateDictionaryEntryHeaders headers) returns DictionaryResponse|error

Updates a dictionary entry.

Parameters

id string - The ID of the dictionary entry to update

payload DictionaryEntryUpdateRequest - The request payload

headers UpdateDictionaryEntryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse|error - The returned dictionary response

listDictionaryCategories

Isolated FunctionRemote Function

function listDictionaryCategories(ListDictionaryCategoriesHeaders headers, *ListDictionaryCategoriesQueries queries) returns DictionaryResponse[]|error

Retrieves a list of your workspace's dictionary categories.

Parameters

headers ListDictionaryCategoriesHeaders (default {}) - Headers to be sent with the request

queries *ListDictionaryCategoriesQueries - Queries to be sent with the request

Return Type

DictionaryResponse[]|error - Returns a list of all dictionary categories. The content data is partly made up of information as described in POST /glossarycategory. Additionally, each category contains the following information: * childCategories: Array of prefixed IDs of categories that have this category as parent category. * childCategoryCount: The number of child categories. * glossaryId: ID of the workspaces’s Dictionary (not relevant for API access). * itemCount: The number of dictionary entries in this category (excluding those in sub-categories). * items: Array of IDs of the contained dictionary entries (deprecated). * If the category corresponds to one of the six standard categories, this field is set. For example, some reports consider the content of these categories. The following oldCategories exist: * ORG_UNIT - Organizational units * DOCUMENT - Documents * ACTIVITY - Activities * STATE - Events * IT_SYSTEM - IT systems * NONE - Everything else

createDictionaryCategory

Isolated FunctionRemote Function

function createDictionaryCategory(DictionaryCategoryRequest payload, CreateDictionaryCategoryHeaders headers) returns DictionaryResponse|error

Creates a dictionary category.

Parameters

payload DictionaryCategoryRequest - The request payload

headers CreateDictionaryCategoryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse|error - The newly created category

getDictionaryCategory

Isolated FunctionRemote Function

function getDictionaryCategory(string id, GetDictionaryCategoryHeaders headers) returns DictionaryResponse[]|error

Retrieves the specified dictionary category.

Parameters

id string - The ID of the dictionary category to retrieve

headers GetDictionaryCategoryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse[]|error - A list of this category's sub-categories (rel is cat), and an object with information on the category itself (rel is info). Sending a GET request to /p/glossarycategory/(id)/info request will fetch the information object only

updateDictionaryCategory

Isolated FunctionRemote Function

function updateDictionaryCategory(string id, DictionaryCategoryRequest payload, UpdateDictionaryCategoryHeaders headers) returns DictionaryResponse|error

Updates an existing dictionary category.

Parameters

id string - The ID of the dictionary category to update

payload DictionaryCategoryRequest - The request payload

headers UpdateDictionaryCategoryHeaders (default {}) - Headers to be sent with the request

Return Type

DictionaryResponse|error - The returned dictionary response

deleteDictionaryCategory

Isolated FunctionRemote Function

function deleteDictionaryCategory(string id, DeleteDictionaryCategoryHeaders headers, *DeleteDictionaryCategoryQueries queries) returns SuccessResponse|error

Deletes a dictionary category.

Parameters

id string - The dictionary category to delete

headers DeleteDictionaryCategoryHeaders (default {}) - Headers to be sent with the request

queries *DeleteDictionaryCategoryQueries - Queries to be sent with the request

Return Type

SuccessResponse|error - The returned success response

getRootDirectories

Isolated FunctionRemote Function

function getRootDirectories(map<string|string[]> headers) returns HyperMediaObject[]|error

Retrieves your workspace's root folders' metadata.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

HyperMediaObject[]|error - Returns four resources, which represent a workspace's root folders: * Shared Documents folder * My Documents folder * Trash * Dictionary Note: The actual folder names may differ depending on the workspace language. Each resource's rel and type properties differ, depending on the resource type. The folders Shared Documents, My Documents and Trash have the rel field set to dir and are tagged with a type field, which can be either public, private or trash. Such type fields are only defined for root folder structures. For the Dictionary, the rel field is set to glos (from 'glossary'). Hint: Although the href property values start with a / they are relative to the base URL path rather than being absolute URL paths

createDirectory

Isolated FunctionRemote Function

function createDirectory(CreateDirectoryRequest payload, map<string|string[]> headers) returns HyperMediaObject|error

Create a new directory

Parameters

payload CreateDirectoryRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

HyperMediaObject|error - Successfully created folder and returns its meta-data. Hint: The expected HTTP response status is 200 OK rather than 201 Created

getDirectoryContent

Isolated FunctionRemote Function

function getDirectoryContent(DirectoryId id, map<string|string[]> headers) returns HyperMediaObject[]|error

Get meta-data of items in a given directory.

Parameters

id DirectoryId - The ID of the directory to get the content of

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

HyperMediaObject[]|error - Successfully provided meta-data of all items in the directory

moveDirectory

Isolated FunctionRemote Function

function moveDirectory(DirectoryId id, MoveDirectoryRequest payload, map<string|string[]> headers) returns HyperMediaObject|error

Move a given directory.

Parameters

id DirectoryId - The ID of the directory to move

payload MoveDirectoryRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

HyperMediaObject|error - Successfully moved the directory and returned its updated meta-data

deleteDirectory

Isolated FunctionRemote Function

function deleteDirectory(DirectoryId id, map<string|string[]> headers) returns DeleteDirectoryResponse|error

Delete a directory.

Parameters

id DirectoryId - The ID of the directory to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DeleteDirectoryResponse|error - successfully deleted the directory

getDirectoryInfo

Isolated FunctionRemote Function

function getDirectoryInfo(DirectoryId id, map<string|string[]> headers) returns DirectoryInfo|error

Meta-data of a given directory.

Parameters

id DirectoryId - The ID of the directory to get the meta-data of

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DirectoryInfo|error - Successfully provided meta-data of the directory

renameDirectory

Isolated FunctionRemote Function

function renameDirectory(DirectoryId id, RenameDirectoryData payload, map<string|string[]> headers) returns DirectoryInfo|error

Rename a given directory.

Parameters

id DirectoryId - The ID of the directory to rename

payload RenameDirectoryData - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DirectoryInfo|error - Successfully renamed the directory and returned its updated meta-data

publishItem

Isolated FunctionRemote Function

function publishItem(PublishData payload, map<string|string[]> headers) returns HyperMediaObject[]|error

publish/unpublish an item

Parameters

payload PublishData - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

HyperMediaObject[]|error - successfully published or unpublished the item

getModelJson

Isolated FunctionRemote Function

function getModelJson(string modelId, map<string|string[]> headers) returns DiagramJson|error

Get the model diagram as JSON

Parameters

modelId string - The ID of the model to be retrieved

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DiagramJson|error - Workflow model data successfully retrieved

getRevisionJson

Isolated FunctionRemote Function

function getRevisionJson(string revisionId, map<string|string[]> headers) returns DiagramJson|error

Get revision JSON.

Parameters

revisionId string - The ID of the revision to be retrieved

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DiagramJson|error - JSON representation of a model successfully retrieved

getPng

Isolated FunctionRemote Function

function getPng(string modelId, map<string|string[]> headers) returns byte[]|error

Get the model diagram as a PNG image

Parameters

modelId string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

byte[]|error - The binary content of the response

getRevisionPng

Isolated FunctionRemote Function

function getRevisionPng(string revisionId, map<string|string[]> headers) returns byte[]|error

Get revision PNG.

Parameters

revisionId string - Revision ID

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

byte[]|error - The binary content of the response

getBpmnXml

Isolated FunctionRemote Function

function getBpmnXml(string modelId, map<string|string[]> headers, *GetBpmnXmlQueries queries) returns xml|error

Get BPMN 2.0 XML

Parameters

modelId string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetBpmnXmlQueries - Queries to be sent with the request

Return Type

xml|error - The XML response

getRevisionBpmnXml

Isolated FunctionRemote Function

function getRevisionBpmnXml(string revisionId, map<string|string[]> headers, *GetRevisionBpmnXmlQueries queries) returns xml|error

Get revision BPMN 2.0 XML

Parameters

revisionId string - The ID of the model revision

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *GetRevisionBpmnXmlQueries - Queries to be sent with the request

Return Type

xml|error - The XML response

getSvg

Isolated FunctionRemote Function

function getSvg(string modelId, map<string|string[]> headers) returns Response|error

Get the model diagram as an SVG image

Parameters

modelId string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - The raw HTTP response

getRevisionSvg

Isolated FunctionRemote Function

function getRevisionSvg(string revisionId, map<string|string[]> headers) returns Response|error

Get revision SVG.

Parameters

revisionId string - Revision ID

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Response|error - SVG representation

importBpmn20Xml

Isolated FunctionRemote Function

function importBpmn20Xml(BpmnImportRequest payload, map<string|string[]> headers) returns BpmnImportResult|error

Import BPMN 2.0 XML

Parameters

payload BpmnImportRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

BpmnImportResult|error - The returned bpmn import result

getDmnDownloadLink

Isolated FunctionRemote Function

function getDmnDownloadLink(string id, map<string|string[]> headers) returns DmnDownloadLinkResponse|error

Retrieve download link to xml

Parameters

id string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

DmnDownloadLinkResponse|error - Successful response

downloadDmnXml

Isolated FunctionRemote Function

function downloadDmnXml(string id, map<string|string[]> headers) returns byte[]|error

Download DMN XML

Parameters

id string - The download id provided from /dmn-xml-download/{id}

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

byte[]|error - File downloaded successfully

uploadSchemaAndData

Isolated FunctionRemote Function

function uploadSchemaAndData(IngestionDataRequest payload, map<string|string[]> headers) returns UploadSchemaAndDataResponseDto|error

Upload schema and data

Parameters

payload IngestionDataRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

UploadSchemaAndDataResponseDto|error - The returned upload schema and data response dto

getStatus

Isolated FunctionRemote Function

function getStatus(string executionId, map<string|string[]> headers) returns ExecutionStatusDto|error

Get status of ingestion request

Parameters

executionId string - Ingestion request execution Id

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExecutionStatusDto|error - The returned execution status dto

listInitiatives

Isolated FunctionRemote Function

function listInitiatives(map<string|string[]> headers, *ListInitiativesQueries queries) returns Initiative[]|error

List initiatives

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListInitiativesQueries - Queries to be sent with the request

Return Type

Initiative[]|error - The returned initiative list

createInitiative

Isolated FunctionRemote Function

function createInitiative(IncomingInitiative payload, map<string|string[]> headers) returns Initiative|error

Create initiative

Parameters

payload IncomingInitiative - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Initiative|error - Successfully created initiative

getInitiative

Isolated FunctionRemote Function

function getInitiative(UUID initiativeId, map<string|string[]> headers) returns Initiative|error

Get initiative

Parameters

initiativeId UUID - The id of the initiative to retrieve

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Initiative|error - The returned initiative

updateInitiative

Isolated FunctionRemote Function

function updateInitiative(UUID initiativeId, IncomingInitiative payload, map<string|string[]> headers) returns Initiative|error

Update initiative

Parameters

initiativeId UUID - The id of the initiative to update

payload IncomingInitiative - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Initiative|error - Successfully updated initiative

deleteInitiative

Isolated FunctionRemote Function

function deleteInitiative(UUID initiativeId, map<string|string[]> headers) returns error?

Delete initiative

Parameters

initiativeId UUID - The id of the initiative to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successfully deleted initiative

listAssetsInitiative

Isolated FunctionRemote Function

function listAssetsInitiative(UUID initiativeId, map<string|string[]> headers) returns Asset[]|error

List assets from initiative

Parameters

initiativeId UUID - The id of the initiative containing the assets

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Asset[]|error - The returned asset list

createAssetInitiative

Isolated FunctionRemote Function

function createAssetInitiative(UUID initiativeId, IncomingAsset payload, map<string|string[]> headers) returns Asset|error

Create asset in initiative

Parameters

initiativeId UUID - The id of the initiative to add the asset to

payload IncomingAsset - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Asset|error - Successfully created asset

getAssetInitiative

Isolated FunctionRemote Function

function getAssetInitiative(UUID assetId, UUID initiativeId, map<string|string[]> headers) returns Asset|error

Get asset from initiative

Parameters

assetId UUID - The id of the asset to retrieve

initiativeId UUID - The id of the initiative containing the asset

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Asset|error - The returned asset

updateAssetInitiative

Isolated FunctionRemote Function

function updateAssetInitiative(UUID assetId, UUID initiativeId, IncomingAsset payload, map<string|string[]> headers) returns Asset|error

Update asset in initiative

Parameters

assetId UUID - The id of the asset to update

initiativeId UUID - The id of the initiative containing the asset

payload IncomingAsset - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Asset|error - Successfully updated asset

deleteAssetInitiative

Isolated FunctionRemote Function

function deleteAssetInitiative(UUID assetId, UUID initiativeId, map<string|string[]> headers) returns Asset|error

Delete asset from initiative

Parameters

assetId UUID - The id of the asset to delete

initiativeId UUID - The id of the initiative containing the asset

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Asset|error - Successfully deleted asset

listInsightsInInitiative

Isolated FunctionRemote Function

function listInsightsInInitiative(string initiativeId, map<string|string[]> headers, *ListInsightsInInitiativeQueries queries) returns Insight[]|error

Get all insights in an initiative

Parameters

initiativeId string - ID of the initiative whose insights should be listed

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListInsightsInInitiativeQueries - Queries to be sent with the request

Return Type

Insight[]|error - The returned insight list

getInsightInInitiative

Isolated FunctionRemote Function

function getInsightInInitiative(UUID initiativeId, UUID insightId, map<string|string[]> headers) returns Insight|error

Get insight in initiative

Parameters

initiativeId UUID - ID of the initiative to which the insight belongs

insightId UUID - ID of the insight to be retrieved

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Insight|error - The returned insight

listInsights

Isolated FunctionRemote Function

function listInsights(map<string|string[]> headers, *ListInsightsQueries queries) returns Insight[]|error

Get all insights

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListInsightsQueries - Queries to be sent with the request

Return Type

Insight[]|error - The returned insight list

createInsight

Isolated FunctionRemote Function

function createInsight(IncomingInsight payload, map<string|string[]> headers) returns Insight|error

Create an insight

Parameters

payload IncomingInsight - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Insight|error - Successfully created insight

getInsight

Isolated FunctionRemote Function

function getInsight(UUID insightId, map<string|string[]> headers) returns Insight|error

Get insight

Parameters

insightId UUID - The id of the insight to retrieve

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Insight|error - The returned insight

updateInsight

Isolated FunctionRemote Function

function updateInsight(UUID insightId, IncomingInsight payload, map<string|string[]> headers) returns Insight|error

Update insight

Parameters

insightId UUID - The id of the insight to update

payload IncomingInsight - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Insight|error - Successfully updated insight

deleteInsight

Isolated FunctionRemote Function

function deleteInsight(UUID insightId, map<string|string[]> headers) returns json|error

Delete insight

Parameters

insightId UUID - The id of the insight to delete

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

json|error - Successfully deleted insight

retrieveModel

Isolated FunctionRemote Function

function retrieveModel(string id, map<string|string[]> headers) returns ModelResourceResponse[]|error

Retrieve Model

Parameters

id string - The ID of the model to be retrieved

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ModelResourceResponse[]|error - The returned model resource response list

updateModel

Isolated FunctionRemote Function

function updateModel(string id, ModelRequest payload, map<string|string[]> headers, *UpdateModelQueries queries) returns ModelResourceResponse[]|error

Update Model

Parameters

id string - The ID of the model to be updated

payload ModelRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *UpdateModelQueries - Queries to be sent with the request

Return Type

ModelResourceResponse[]|error - The returned model resource response list

deleteModel

Isolated FunctionRemote Function

function deleteModel(string id, map<string|string[]> headers) returns SuccessResponse|error

Delete Model

Parameters

id string - The ID of the model to be deleted

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SuccessResponse|error - The returned success response

createModel

Isolated FunctionRemote Function

function createModel(ModelRequest payload, map<string|string[]> headers, *CreateModelQueries queries) returns ModelResponse|error

Create a new Model

Parameters

payload ModelRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateModelQueries - Queries to be sent with the request

Return Type

ModelResponse|error - The returned model response

listModelRevisions

Isolated FunctionRemote Function

function listModelRevisions(string modelId, map<string|string[]> headers, *ListModelRevisionsQueries queries) returns ModelRevisionsResponse[]|error

Retrieving all revision IDs of a model.

Parameters

modelId string - The model's ID

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListModelRevisionsQueries - Queries to be sent with the request

Return Type

ModelRevisionsResponse[]|error - The returned model revisions response list

updateModelInfo

Isolated FunctionRemote Function

function updateModelInfo(string modelId, ModelInfoRequest payload, map<string|string[]> headers) returns ModelInfoResponse|error

Update model info

Parameters

modelId string - The ID of the model

payload ModelInfoRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ModelInfoResponse|error - Successful operation

checkSyntax

Isolated FunctionRemote Function

function checkSyntax(SyntaxCheckRequest payload, map<string|string[]> headers) returns SyntaxCheckResponse|error

Performs a syntax check on a BPMN 2.0 process model.

Parameters

payload SyntaxCheckRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

SyntaxCheckResponse|error - Syntax check successful

createDiagramDraft

Isolated FunctionRemote Function

function createDiagramDraft(map<string|string[]> headers, *CreateDiagramDraftQueries queries) returns DiagramDraftResponse|error

Create a new model draft.

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *CreateDiagramDraftQueries - Queries to be sent with the request

Return Type

DiagramDraftResponse|error - Model created successfully

getMetaInfo

Isolated FunctionRemote Function

function getMetaInfo(map<string|string[]> headers) returns MetaResponseItem[]|error?

Get meta information

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MetaResponseItem[]|error? - Successfully retrieved meta information

createMetaInfo

Isolated FunctionRemote Function

function createMetaInfo(MetaInfoRequest payload, map<string|string[]> headers) returns MetaResponseItem|error

Create meta information

Parameters

payload MetaInfoRequest - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

MetaResponseItem|error - Successfully created meta information

getExpirationDate

Isolated FunctionRemote Function

function getExpirationDate(string modelID, map<string|string[]> headers) returns ExpirationDate|error

Retrieve the current approval expiration date.

Parameters

modelID string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExpirationDate|error - Successfully retrieved the approval expiration date

updateExpirationDate

Isolated FunctionRemote Function

function updateExpirationDate(string modelID, ExpirationDate payload, map<string|string[]> headers) returns ExpirationDate|error

Update the approval expiration date.

Parameters

modelID string - The ID of the model

payload ExpirationDate - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExpirationDate|error - Successfully updated the approval expiration date

createExpirationDate

Isolated FunctionRemote Function

function createExpirationDate(string modelID, ExpirationDate payload, map<string|string[]> headers) returns ExpirationDate|error

Create a new approval expiration date.

Parameters

modelID string - The ID of the model

payload ExpirationDate - The request payload

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ExpirationDate|error - Successfully created the approval expiration date

deleteExpirationDate

Isolated FunctionRemote Function

function deleteExpirationDate(string modelID, map<string|string[]> headers) returns error?

Delete the current approval expiration date.

Parameters

modelID string - The ID of the model

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

error? - Successfully deleted the approval expiration date

listObjectives

Isolated FunctionRemote Function

function listObjectives(map<string|string[]> headers, *ListObjectivesQueries queries) returns ObjectivesResponse|error

Get all objectives

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *ListObjectivesQueries - Queries to be sent with the request

Return Type

ObjectivesResponse|error - Success returns objectives wrapped in value array

getObjective

Isolated FunctionRemote Function

function getObjective(string objectiveSid, map<string|string[]> headers) returns Objective|error

Get objective by SID

Parameters

objectiveSid string - The Suite Objective ID (SID) (e.g. SuiteObjective_<32 hex chars>)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

Objective|error - The returned objective

getInitiativesByObjective

Isolated FunctionRemote Function

function getInitiativesByObjective(string objectiveSid, map<string|string[]> headers) returns InitiativeSummaryForObjective[]|error

Get linked initiatives

Parameters

objectiveSid string - The Suite Objective ID (SID) (e.g. SuiteObjective_<32 hex chars>)

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

InitiativeSummaryForObjective[]|error - The returned initiative summary for objective list

search

Isolated FunctionRemote Function

function search(map<string|string[]> headers, *SearchQueries queries) returns Response|error

Search the workspace

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *SearchQueries - Queries to be sent with the request

Return Type

Response|error - JSON array containing folder and model object representations. In the response object with rel="search", the totalNrOfResults property gives the total number of results. When there are more than 250 results, the API limits the response array to the first 250 results. You can use the offset=250 request parameter to fetch the second ‘page’ of results

getServiceDocument

Isolated FunctionRemote Function

function getServiceDocument(map<string|string[]> headers) returns ServiceDocument|error

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

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

ServiceDocument|error - List all entity sets (OData views) the user has access to. The user has access if the underlying resources which the SIGNAL query in the view accesses (tables/views) are accessible. If this is not the case the entity (view) is not returned. A JSON list is given with all entities

getMetadata

Isolated FunctionRemote Function

function getMetadata(map<string|string[]> headers) returns xml|error

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

Parameters

headers map<string|string[]> (default {}) - Headers to be sent with the request

Return Type

xml|error - Metadata information for all entity sets (OData views) the user has access to. The user has access if the underlying resources which the SIGNAL query in the view accesses (tables/views) are accessible. If this is not the case the entity (view) is not returned. A XML schema is given as metadata

queryEntitySet

Isolated FunctionRemote Function

function queryEntitySet(string entitySetName, map<string|string[]> headers, *QueryEntitySetQueries queries) returns OdataOutput|error

This endpoint implements an OData service endpoint according to version 4.0 of the OData Protocol specification.

Parameters

entitySetName string - The name for the entity set (in this case, the oData view). Can be returned by calling the /$metadata endpoint

headers map<string|string[]> (default {}) - Headers to be sent with the request

queries *QueryEntitySetQueries - Queries to be sent with the request

Return Type

OdataOutput|error - Data for the given entity, returned as a JSON schema

Records

sap.signavio: Asset

Represents the asset.

Fields

initiative Initiative - The initiative

updatedBy? UserInfo - The updated by

dateCreated OffsetDateTime - The date created

createdBy UserInfo - The created by

name string - The name

description? string - The description

id UUID - The unique identifier

'type AssetType - The type

url string - The url

dateUpdated OffsetDateTime - The date updated

sap.signavio: AuthenticateHeaders

Represents the Headers record for the operation: authenticate

Fields

contentType? string - Required request body format

sap.signavio: Authorization

Represents the authorization.

Fields

role Role - The role

targetType AuthorizationType - The target type

target AuthorizationTargetInfo - The target

sap.signavio: AuthorizationTargetInfo

Represents the authorization target info.

Fields

displayName? string - The display name

id UUID - The unique identifier

sap.signavio: AutomaticMeasurement

Represents the automatic measurement.

Fields

'type "NPS"|"CSAT"|"CES" - The type

value CesMeasurement|CsatMeasurement|NPSMeasurement - The value

sap.signavio: BenchmarkingAnalyticsContext

Represents the benchmarking analytics context.

Fields

metricBenchmarkContainerId? string - The metric benchmark container id

e2eProcessId? string - The e2e process id

sap.signavio: BpmnImportRequest

Represents the bpmn import request.

Fields

bpmn2File record { fileContent byte[], fileName string } - The filename and content of the BPMN 2.0 XML file

modelid? string - The ID of the model to create a new revision for

directory? string - The directory where the content of the BPMN 2.0 XML file should be imported into

sap.signavio: BpmnImportResult

Represents the bpmn import result.

Fields

numUpdated? int - The number of updated models

createdIds? string[] - The IDs of the created models

warnings? Messages - The warnings

mainModelId? string - The ID of the main model

numCreated? int - The number of created models

updatedIds? string[] - The IDs of the updated models

errors? Messages - The list of errors

sap.signavio: CasesIdResourceAttribute

The JSON:API resource ID

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: CasesProcessIdResourceAttribute

Represents the cases process id resource attribute.

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: CasesResourceAttributes

Represents the cases resource attributes.

Fields

attributes? CasesResourceAttributesAttributes - The attributes

sap.signavio: CasesResourceAttributesAttributes

Represents the cases resource attributes attributes.

Fields

creator? CasesCreatorResourceAttribute - The creator

variables? CasesVariablesResourceAttribute? - The variables

milestone? CasesMilestoneResourceAttribute? - The milestone

processId? CasesProcessIdResourceAttribute? - The process id

caseNumber? CasesCaseNumberResourceAttribute? - The case number

created? CasesCreatedResourceAttribute? - The created

name? CasesNameResourceAttribute? - The name

closed? CasesClosedResourceAttribute? - The closed

priority? CasesPriorityResourceAttribute? - The priority

tasks? CasesTasksResourceAttribute? - The tasks

applicationLink? CasesApplicationLinkResourceAttribute? - The application link

sap.signavio: CasesResourceReference

Represents the cases resource reference.

Fields

id CasesIdResourceAttribute - The JSON:API resource ID

'type "Cases" - The JSON:API resource type (Cases)

sap.signavio: CasesResourceReferenceResponseSchema

Represents the cases resource reference response schema.

Fields

data? CasesResourceReference - The data

sap.signavio: CasesResourceReferencesResponseSchema

Represents the cases resource references response schema.

Fields

data? CasesResourceReference[] - The data

sap.signavio: CasesResourceResponseSchema

Represents the cases resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data CasesResourceSchema - The data

sap.signavio: CasesResourceSchema

Represents the cases resource schema.

Fields

Fields Included from *CasesResourceReference

id CasesIdResourceAttribute
type "Cases"
anydata...

Fields Included from *CasesResourceAttributes

attributes CasesResourceAttributesAttributes
anydata...

attributes CasesResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: CasesResourcesResponseSchema

Represents the cases resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data CasesResourceSchema[] - The data

sap.signavio: CaseVariablesIdResourceAttribute

The JSON:API resource ID

Fields

cazeId? CaseVariablesIdResourceAttributeCazeId - The case identifier

id? string - The unique identifier

sap.signavio: CaseVariablesIdResourceAttributeCazeId

Represents the case variables id resource attribute caze id.

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: CaseVariablesResourceAttributes

Represents the case variables resource attributes.

Fields

attributes? CaseVariablesResourceAttributesAttributes - The attributes

sap.signavio: CaseVariablesResourceAttributesAttributes

Represents the case variables resource attributes attributes.

Fields

values? CaseVariablesValuesResourceAttribute? - The values

name? CaseVariablesNameResourceAttribute? - The name

defaultValues? CaseVariablesDefaultValuesResourceAttribute? - The default values

description? CaseVariablesDescriptionResourceAttribute? - The description

variableId? CaseVariablesVariableIdResourceAttribute? - The variable id

case? CaseVariablesCaseResourceAttribute - The case

sap.signavio: CaseVariablesResourceReference

Represents the case variables resource reference.

Fields

id CaseVariablesIdResourceAttribute - The JSON:API resource ID

'type "Case-variables" - The JSON:API resource type (Case-variables)

sap.signavio: CaseVariablesResourceReferencesResponseSchema

Represents the case variables resource references response schema.

Fields

data? CaseVariablesResourceReference[] - The data

sap.signavio: CaseVariablesResourceResponseSchema

Represents the case variables resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data CaseVariablesResourceSchema - The data

sap.signavio: CaseVariablesResourceSchema

Represents the case variables resource schema.

Fields

Fields Included from *CaseVariablesResourceReference

id CaseVariablesIdResourceAttribute
type "Case-variables"
anydata...

Fields Included from *CaseVariablesResourceAttributes

attributes CaseVariablesResourceAttributesAttributes
anydata...

attributes CaseVariablesResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: CaseVariablesResourcesResponseSchema

Represents the case variables resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data CaseVariablesResourceSchema[] - The data

sap.signavio: CesMeasurement

Represents the ces measurement.

Fields

Fields Included from *Measurement

score Signed32
time string
anydata...

numDifficult Signed32 - The num difficult

numVeryDifficult? Signed32 - The num very difficult

numBitEasy? Signed32 - The num bit easy

scale "ONE_TO_THREE"|"ONE_TO_FIVE"|"ONE_TO_SEVEN" - The scale

numVeryEasy? Signed32 - The num very easy

numNeutral Signed32 - The num neutral

numEasy Signed32 - The num easy

numBitDifficult? Signed32 - The num bit difficult

sap.signavio: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth Credentials - SAP Signavio account credentials

region string(default "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 HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol

timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

followRedirects? FollowRedirects - Configurations associated with Redirection

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache CacheConfig(default {}) - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

cookieConfig? CookieConfig - Configurations associated with cookies

responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled, nil values are treated as optional, and absent fields are handled as nilable types. Enabled by default.

sap.signavio: CreateDiagramDraftQueries

Represents the Queries record for the operation: createDiagramDraft

Fields

stencilset string - The notation URI value for the stencil set

sap.signavio: CreateDictionaryCategoryHeaders

Represents the Headers record for the operation: createDictionaryCategory

Fields

contentType string(default "application/x-www-form-urlencoded") - application/x-www-form-urlencoded

sap.signavio: CreateDictionaryEntryHeaders

Represents the Headers record for the operation: createDictionaryEntry

sap.signavio: CreateDirectoryRequest

Represents the create directory request.

Fields

parent? ObjectReference - The parent

name? string - The name

sap.signavio: CreateModelQueries

Represents the Queries record for the operation: createModel

Fields

dc? string - A timestamp or unique string used to prevent caching issues

sap.signavio: Credentials

Closed record

SAP Signavio account credentials. The connector uses these to transparently obtain both the API gateway access token (POST /auth/v1/token) and the Process Manager workspace session (POST /p/login) - no separate login step is required from the caller.

Fields

username string - The account's user name (typically an email address)

password string - The account's password

tenant? string - Unique identifier of the target workspace. Only necessary if the authenticating user is a member of multiple workspaces

odataAccessToken? string - 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, and that token can only be generated from the SAP Signavio UI, so it cannot be derived from username/password automatically

sap.signavio: CsatMeasurement

Represents the csat measurement.

Fields

Fields Included from *Measurement

score Signed32
time string
anydata...

numDissatisfied Signed32 - The num dissatisfied

numHighlySatisfied Signed32 - The num highly satisfied

numHighlyDissatisfied Signed32 - The num highly dissatisfied

numSatisfied Signed32 - The num satisfied

numNeutral Signed32 - The num neutral

sap.signavio: DeleteDictionaryCategoryHeaders

Represents the Headers record for the operation: deleteDictionaryCategory

sap.signavio: DeleteDictionaryCategoryQueries

Represents the Queries record for the operation: deleteDictionaryCategory

Fields

moveContent boolean - 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

sap.signavio: DeleteDictionaryEntryHeaders

Represents the Headers record for the operation: deleteDictionaryEntry

sap.signavio: DeleteDirectoryResponse

Represents the delete directory response.

Fields

success? boolean - The success

sap.signavio: DiagramDraftResponse

Represents the diagram draft response.

Fields

id? string - The unique identifier

sap.signavio: DiagramJson

Represents the diagram json.

Fields

resourceId? string - The resource id

properties? record {} - The properties

childShapes? DiagramJsonChildShape[] - The child shapes

sap.signavio: DiagramJsonChildShape

Represents the diagram json child shape.

Fields

resourceId? string - The resource id

properties? record {} - The properties

sap.signavio: DictionaryCategoryRequest

Represents the dictionary category request.

Fields

color string - A HEX color to display with the category, for example #800000 (dark red)

hidden? boolean - If set to true, the category will be invisible to all users

restricted? boolean - If set to true, the category may only be accessible to users who own a specific privilege

name string - The category's name

parentCategory string - The category's parent category. Leave the parameter unset to create the category on the top-most level

'order int - The order the category will take among categories within the same context

sap.signavio: DictionaryEntryRequest

Represents the dictionary entry request.

Fields

attachments? Spmv1glossaryAttachments[] - Add a single attachment as an object. For multiple attachments, add them as an array of objects:
```
  [
    {"url":"http://www.example.com", "label":"Example"}
  ]
```

metaDataValues? record {} - A JSON object containing ID-to-value mappings of custom attributes, for example:

  {
    "meta-my-single-line-text": "one",
    "meta-my-multi-line-text": "two\nthree\nfour",
    "meta-my-dictionary-link": "/glossary/3aabd26a654c4123a71c597210810000",
    "meta-my-date": "2018-12-24T16:46:00.000Z",
    "meta-my-number": "42",
    "meta-my-drop-down": "ci1545668214217710650210",
    "meta-my-url": {
      "label": "Example",
      "url": "http://www.example.com/"
    },
    "meta-my-boolean": true
  }

description? string - A description of the entry

title string - The entry's title

category string - The desired dictionary category's ID

sap.signavio: DictionaryEntryUpdateRequest

Represents the dictionary entry update request.

Fields

attachments? Spmv1glossaryAttachments[] - The attachments

metaDataValues? record {} - The meta data values

description? string - A description of the entry

force? boolean - Force the update to occur. This parameter must be set to true if the item being updated has a non-unique name

title string - The entry's title

category string - The desired dictionary category's ID

sap.signavio: DictionaryResponse

Represents the dictionary response.

Fields

rel string - The relation type

href string - The hypermedia link

rep json - The representation payload

sap.signavio: DirectoryInfo

This object can contain dynamic localized 'name' variants with the locale as a suffix of the attribute, e.g. name_fr_fr, name_en_us, name_de_de, etc

Fields

parent? ObjectReference - The identifier of the parent item

allowedMimeTypeRegex? string - A regular expression describing the allowed MIME types

parentName? string - The name of the parent item

deleted? boolean - Whether the item has been deleted

visible? boolean - Whether the item is visible

created? string - The time of creation. Dates are expressed according to ISO 8601, with a space as separator and with timezone, example: "2024-02-26 14:21:35 +0000"

name string - The name of the item

description? string - A description of the item

sap.signavio: DiscoveryReference

Represents the discovery reference.

Fields

benchmarkingAnalyticsContext? BenchmarkingAnalyticsContext - The benchmarking analytics context

dateCreated OffsetDateTime - The date created

endDate? OffsetDateTime - The end date

processIntelligenceContext? ProcessIntelligenceContext - The process intelligence context

processInsightsContext? ProcessInsightsContext - The process insights context

id UUID - The unique identifier

sri string - The sri

additionalContext? record { string... } - The additional context

url? string - The url

startDate? OffsetDateTime - The start date

dateUpdated OffsetDateTime - The date updated

sap.signavio: DmnDownloadLinkResponse

Represents the dmn download link response.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? DmnDownloadRepresentation - The representation payload

sap.signavio: DmnDownloadRepresentation

Represents the dmn download representation.

Fields

success? boolean - The success

downloadUrl? string - The download url

messages? string[] - The messages

sap.signavio: ExecutionStatusDto

Represents the execution status dto.

Fields

displayStatus string - The display status

message string - The message

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" - The status

sap.signavio: ExpirationDate

Represents the expiration date.

Fields

reApprovalDate? string - The re approval date

sap.signavio: FilesIdResourceAttribute

The JSON:API resource ID

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: FilesResourceAttributes

Represents the files resource attributes.

Fields

attributes? FilesResourceAttributesAttributes - The attributes

sap.signavio: FilesResourceAttributesAttributes

Represents the files resource attributes attributes.

Fields

size? FilesSizeResourceAttribute - The size

name? FilesNameResourceAttribute? - The name

sap.signavio: FilesResourceReference

Represents the files resource reference.

Fields

id FilesIdResourceAttribute - The JSON:API resource ID

'type "Files" - The JSON:API resource type (Files)

sap.signavio: FilesResourceReferencesResponseSchema

Represents the files resource references response schema.

Fields

data? FilesResourceReference[] - The data

sap.signavio: FilesResourceResponseSchema

Represents the files resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data FilesResourceSchema - The data

sap.signavio: FilesResourceSchema

Represents the files resource schema.

Fields

Fields Included from *FilesResourceReference

id FilesIdResourceAttribute
type "Files"
anydata...

Fields Included from *FilesResourceAttributes

attributes FilesResourceAttributesAttributes
anydata...

attributes FilesResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: FilesResourcesResponseSchema

Represents the files resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data FilesResourceSchema[] - The data

sap.signavio: GetBpmnXmlQueries

Represents the Queries record for the operation: getBpmnXml

Fields

exportSubprocesses? boolean - Whether to include linked subprocesses

language? string - Which tenant content language to use as the primary language of the exported XML

sap.signavio: GetCaseCreatorHeaders

Represents the Headers record for the operation: getCaseCreator

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetCaseCreatorQueries

Represents the Queries record for the operation: getCaseCreator

Fields

fields string(default "id,name,email") - users fields to include (csv)

sap.signavio: GetCaseHeaders

Represents the Headers record for the operation: getCase

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetCaseQueries

Represents the Queries record for the operation: getCase

Fields

include string(default "creator,tasks,variables") - cases relationships to include (csv)

'field string(default "id,creator") - cases field to include

sap.signavio: GetCaseVariableHeaders

Represents the Headers record for the operation: getCaseVariable

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetCaseVariableQueries

Represents the Queries record for the operation: getCaseVariable

Fields

include string(default "case") - case-variables relationship to include

sap.signavio: GetDictionaryCategoryHeaders

Represents the Headers record for the operation: getDictionaryCategory

sap.signavio: GetDictionaryEntryHeaders

Represents the Headers record for the operation: getDictionaryEntry

sap.signavio: GetDictionaryEntryInfoHeaders

Represents the Headers record for the operation: getDictionaryEntryInfo

sap.signavio: GetFileHeaders

Represents the Headers record for the operation: getFile

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetFileQueries

Represents the Queries record for the operation: getFile

Fields

fields string(default "id,name,size") - files fields to include (csv)

sap.signavio: GetGroupHeaders

Represents the Headers record for the operation: getGroup

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetGroupQueries

Represents the Queries record for the operation: getGroup

Fields

include string(default "users") - groups relationships to include (csv)

fields string(default "id,name,users") - groups fields to include (csv)

sap.signavio: GetRevisionBpmnXmlQueries

Represents the Queries record for the operation: getRevisionBpmnXml

Fields

exportSubprocesses? boolean - Whether to include linked subprocesses

language? string - Which tenant content language to use as the primary language of the exported XML

sap.signavio: GetTaskCaseHeaders

Represents the Headers record for the operation: getTaskCase

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetTaskCaseQueries

Represents the Queries record for the operation: getTaskCase

Fields

'field string(default "id,creator") - cases field to include

sap.signavio: GetTaskCaseRefHeaders

Represents the Headers record for the operation: getTaskCaseRef

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetTaskHeaders

Represents the Headers record for the operation: getTask

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetTaskQueries

Represents the Queries record for the operation: getTask

Fields

include string(default "case") - tasks relationships to include (csv)

fields string(default "id") - tasks field to include

sap.signavio: GetUserHeaders

Represents the Headers record for the operation: getUser

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: GetUserQueries

Represents the Queries record for the operation: getUser

Fields

fields string(default "id,name,email") - users fields to include (csv)

sap.signavio: GroupsIdResourceAttribute

The JSON:API resource ID

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: GroupsResourceAttributes

Represents the groups resource attributes.

Fields

attributes? GroupsResourceAttributesAttributes - The attributes

sap.signavio: GroupsResourceAttributesAttributes

Represents the groups resource attributes attributes.

Fields

name? GroupsNameResourceAttribute? - The name

users? GroupsUsersResourceAttribute? - The users

sap.signavio: GroupsResourceReference

Represents the groups resource reference.

Fields

id GroupsIdResourceAttribute - The JSON:API resource ID

'type "Groups" - The JSON:API resource type (Groups)

sap.signavio: GroupsResourceReferencesResponseSchema

Represents the groups resource references response schema.

Fields

data? GroupsResourceReference[] - The data

sap.signavio: GroupsResourceResponseSchema

Represents the groups resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data GroupsResourceSchema - The data

sap.signavio: GroupsResourceSchema

Represents the groups resource schema.

Fields

Fields Included from *GroupsResourceReference

id GroupsIdResourceAttribute
type "Groups"
anydata...

Fields Included from *GroupsResourceAttributes

attributes GroupsResourceAttributesAttributes
anydata...

attributes GroupsResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: GroupsResourcesResponseSchema

Represents the groups resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data GroupsResourceSchema[] - The data

sap.signavio: HyperMediaObject

Represents the hyper media object.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? json - The representation payload

sap.signavio: IncomingAsset

Represents the incoming asset.

Fields

name string - The name

description? string - The description

'type AssetType - The type

url string - The url

sap.signavio: IncomingAuthorization

Represents the incoming authorization.

Fields

role Role - The role

targetId UUID - The target id

targetType AuthorizationType - The target type

sap.signavio: IncomingInitiative

Represents the incoming initiative.

Fields

endDate? OffsetDateTime - The end date

name string - The name

valueDrivers ValueDriver[] - The value drivers

authorizations IncomingAuthorization[] - The authorizations

description? string - The description

startDate? OffsetDateTime - The start date

status InitiativeStatus - The status

sap.signavio: IncomingInsight

Represents the incoming insight.

Fields

name string - The name

valueDrivers InsightsValueDriver[] - The value drivers

priorityScore float - The priority score

authorizations IncomingAuthorization[] - The authorizations

description? string - The description

initiatives? IncomingInsightInitiativesItemsString[] - The initiatives

assignees IncomingInsightAssigneesItemsString[] - The assignees

effortScore float - The effort score

impactScore float - The impact score

status InsightStatus - The status

sap.signavio: IngestionDataRequest

Represents the ingestion data request.

Fields

schema string - A Schema is represented in JSON following Apache Avro Specification of type record to define the table structure

primaryKeys string[] - Comma separated list of primary keys, for example primaryKeys=key1,key2,key3 (values must exist in the provided Schema)

delimiter string(default ",") - A character separating the data in the files. Default value is ","

files record { fileContent byte[], fileName string }[] - The data to be pushed. Supported formats are CSV and TSV

sap.signavio: Initiative

Represents the initiative.

Fields

updatedBy UserInfo - The updated by

endDate? OffsetDateTime - The end date

valueDrivers ValueDriver[] - The value drivers

authorizations Authorization[] - The authorizations

description? string - The description

sri string - The sri

'type InitiativeType - The type

dateUpdated OffsetDateTime - The date updated

dateCreated OffsetDateTime - The date created

createdBy UserInfo - The created by

name string - The name

lastActivity OffsetDateTime - The last activity

id UUID - The unique identifier

startDate? OffsetDateTime - The start date

status InitiativeStatus - The status

sap.signavio: InitiativeSummaryForObjective

Represents the initiative summary for objective.

Fields

updatedBy? UserInfo - The updated by

endDate? OffsetDateTime - The end date

valueDrivers ValueDriver[] - The value drivers

authorizations Authorization[] - The authorizations

description? string - The description

'type InitiativeType - The type

sid string - The sid

dateUpdated OffsetDateTime - The date updated

dateCreated OffsetDateTime - The date created

createdBy UserInfo - The created by

name string - The name

lastActivity OffsetDateTime - The last activity

startDate? OffsetDateTime - The start date

status InitiativeStatus - The status

sap.signavio: Insight

Represents the insight.

Fields

updatedBy UserInfo - The updated by

valueDrivers InsightsValueDriver[] - The value drivers

authorizations Authorization[] - The authorizations

description? string - The description

assignees UserInfo[] - The assignees

sri string - The sri

dateUpdated OffsetDateTime - The date updated

tags Tag[] - The tags

dateCreated OffsetDateTime - The date created

createdBy UserInfo - The created by

discoveries DiscoveryReference[] - The discoveries

name string - The name

priorityScore float - The priority score

initiatives? InsightInitiativesItemsString[] - The initiatives

id UUID - The unique identifier

effortScore float - The effort score

impactScore float - The impact score

status InsightStatus - The status

sap.signavio: JsonApi

Closed record

Represents the json api.

Fields

version? string - The version

sap.signavio: Links

Link members related to the primary data

Fields

Fields Included from *Pagination

next string|()
last string|()
prev string|()
first string|()
anydata...

sap.signavio: ListCasesHeaders

Represents the Headers record for the operation: listCases

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListCasesQueries

Represents the Queries record for the operation: listCases

Fields

pageLimit int(default 100) - Max number of items

include string(default "creator,tasks,variables") - cases relationships to include (csv)

pageOffset int(default 0) - Page offset

filterProcessId? string - Filter by processId

'field string(default "id,creator") - cases field to include

sap.signavio: ListCaseTasksHeaders

Represents the Headers record for the operation: listCaseTasks

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListCaseTasksQueries

Represents the Queries record for the operation: listCaseTasks

Fields

fields string(default "id") - tasks field to include

filterId? string - Filter by id (csv)

sap.signavio: ListCaseVariableCaseRefsHeaders

Represents the Headers record for the operation: listCaseVariableCaseRefs

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListCaseVariableCaseRefsQueries

Represents the Queries record for the operation: listCaseVariableCaseRefs

Fields

include string(default "creator,tasks,variables") - cases relationships to include (csv)

'field string(default "id,creator") - cases field to include

sap.signavio: ListCaseVariableCasesHeaders

Represents the Headers record for the operation: listCaseVariableCases

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListCaseVariableCasesQueries

Represents the Queries record for the operation: listCaseVariableCases

Fields

include string(default "creator,tasks,variables") - cases relationships to include (csv)

'field string(default "id,creator") - cases field to include

sap.signavio: ListCaseVariablesHeaders

Represents the Headers record for the operation: listCaseVariables

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListCaseVariablesQueries

Represents the Queries record for the operation: listCaseVariables

Fields

pageLimit int(default 100) - Max number of items

include string(default "case") - case-variables relationship to include

pageOffset int(default 0) - Page offset

filterId string - Filter by id (csv)

sap.signavio: ListDictionaryCategoriesHeaders

Represents the Headers record for the operation: listDictionaryCategories

sap.signavio: ListDictionaryCategoriesQueries

Represents the Queries record for the operation: listDictionaryCategories

Fields

showHidden? boolean - If set to true, hidden categories are included in the response

allCategories? boolean - If set to true, all categories' representations are returned at once, without the need to send additional queries for sub-categories

considerAllPrivilege? boolean - To circumvent access restrictions as a member of the workspace's administrators group, set this parameter to true

sap.signavio: ListDictionaryEntriesHeaders

Represents the Headers record for the operation: listDictionaryEntries

Fields

contentType string(default "application/x-www-form-urlencoded") - application/x-www-form-urlencoded

sap.signavio: ListDictionaryEntriesQueries

Represents the Queries record for the operation: listDictionaryEntries

Fields

q? string - Filters by a full-text search term (ignored when letter is specified)

include? string - If set to all, dictionary entries from a category and its subcategories are listed

offset? int - The number of entries to skip before returning entries. Useful in combination with limit for pagination

letter? string - Filters by the initial letter of the dictionary entry's title

'limit? int - The maximum number of entries to return

sort? string - If set to title, sorts entries by title; otherwise, the search sorts results by a dynamically determined relevance score

category? string - 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

sap.signavio: ListFilesHeaders

Represents the Headers record for the operation: listFiles

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListFilesQueries

Represents the Queries record for the operation: listFiles

Fields

pageLimit int(default 100) - Max number of items

pageOffset int(default 0) - Page offset

filterId? string - Filter by id (csv)

sap.signavio: ListGroupsHeaders

Represents the Headers record for the operation: listGroups

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListGroupsQueries

Represents the Queries record for the operation: listGroups

Fields

pageLimit int(default 100) - Max number of items

include string(default "users") - groups relationships to include (csv)

pageOffset int(default 0) - Page offset

fields string(default "id,name,users") - groups fields to include (csv)

filterId? string - Filter by id (csv)

sap.signavio: ListGroupUserRefsHeaders

Represents the Headers record for the operation: listGroupUserRefs

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListGroupUsersHeaders

Represents the Headers record for the operation: listGroupUsers

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListGroupUsersQueries

Represents the Queries record for the operation: listGroupUsers

Fields

fields string(default "id,name,email") - users fields to include (csv)

sap.signavio: ListInitiativesQueries

Represents the Queries record for the operation: listInitiatives

Fields

search? string - Full-text search query for initiative name and description. Minimum 3 characters required; shorter queries are ignored

pageNumber Signed32(default 1) - Page number (1-based, the first page has number 1)

nameContains? string - Only list initiatives that contain this substring. This parameter can be repeated

valueDriver? ValueDriver - Only list initiatives containing this value driver. This parameter can be repeated

createdBy? UUID - Only list initiatives which were created by this user. This parameter can be repeated

authorizationRole? Role - Only list initiatives where the user has the specified access role. This parameter can be repeated

sortOrder "Ascending"|"Descending" (default "Ascending") - Order to sort the initiatives by

hasMember? UUID - Only list initiatives which this user is a member. This parameter can be repeated

pageSize Signed32(default 10) - Number of entries per page

sortBy "dateCreated"|"dateUpdated"|"name"|"startDate"|"endDate"|"lastActivity"|"numberOfInsights" (default "dateCreated") - Initiative property to sort by

status? InitiativeStatus - Only list initiatives with this status. This parameter can be repeated

sap.signavio: ListInsightsInInitiativeQueries

Represents the Queries record for the operation: listInsightsInInitiative

Fields

pageNumber Signed32(default 1) - Page number (1-based, the first page has number 1)

nameContains? string - Only list insights that contain this substring. This parameter can be repeated

processIntelligenceCanvasType? "INVESTIGATION"|"DASHBOARD" - 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" - 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" - Only list insights containing discoveries with this domain application. This parameter can be repeated

processInsightsProcessFlowId? string - Only list insights containing discoveries from process insights with this process flow id. This parameter can be repeated

pageSize Signed32(default 10) - Number of entries per page

processIntelligenceWidgetId? string - Only list insights containing discoveries from process intelligence with this widget id. This parameter can be repeated

processIntelligenceProcessId? string - Only list insights containing discoveries from process intelligence with this process id. This parameter can be repeated

createdBy? string - Only list insights which were created by this user. This parameter can be repeated

processInsightsSystemId? string - Only list insights containing discoveries from process insights with this system id. This parameter can be repeated

sortOrder "Ascending"|"Descending" (default "Ascending") - Order to sort the initiatives by

processIntelligenceCanvasId? string - Only list insights containing discoveries from process intelligence with this canvas id. This parameter can be repeated

sortBy "dateCreated"|"dateUpdated"|"name"|"impactScore"|"effortScore"|"priorityScore" (default "dateCreated") - Initiative property to sort by

tag? string - Only list insights which contain this tag. This parameter can be repeated

assignee? string - Only list insights which are assigned to this user. This parameter can be repeated

discoveryReferenceSRI? string - Only list insights containing discoveries with this SRI. This parameter can be repeated

status? "OPEN"|"IN_PROGRESS"|"RESOLVED" - Only list insights with this status. This parameter can be repeated

sap.signavio: ListInsightsQueries

Represents the Queries record for the operation: listInsights

Fields

pageNumber Signed32(default 1) - Page number (1-based, the first page has number 1)

nameContains? string - Only list insights that contain this substring. This parameter can be repeated

processIntelligenceCanvasType? "INVESTIGATION"|"DASHBOARD" - 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" - 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" - Only list insights containing discoveries with this domain application. This parameter can be repeated

processInsightsProcessFlowId? string - Only list insights containing discoveries from process insights with this process flow id. This parameter can be repeated

pageSize Signed32(default 10) - Number of entries per page

processIntelligenceWidgetId? string - Only list insights containing discoveries from process intelligence with this widget id. This parameter can be repeated

processIntelligenceProcessId? string - Only list insights containing discoveries from process intelligence with this process id. This parameter can be repeated

createdBy? string - Only list insights which were created by this user. This parameter can be repeated

processInsightsSystemId? string - Only list insights containing discoveries from process insights with this system id. This parameter can be repeated

sortOrder "Ascending"|"Descending" (default "Ascending") - Order to sort the initiatives by

processIntelligenceCanvasId? string - Only list insights containing discoveries from process intelligence with this canvas id. This parameter can be repeated

sortBy "dateCreated"|"dateUpdated"|"name"|"impactScore"|"effortScore"|"priorityScore" (default "dateCreated") - Initiative property to sort by

tag? string - Only list insights which contain this tag. This parameter can be repeated

assignee? string - Only list insights which are assigned to this user. This parameter can be repeated

discoveryReferenceSRI? string - Only list insights containing discoveries with this SRI. This parameter can be repeated

status? "OPEN"|"IN_PROGRESS"|"RESOLVED" - Only list insights with this status. This parameter can be repeated

sap.signavio: ListModelRevisionsQueries

Represents the Queries record for the operation: listModelRevisions

Fields

offset? Signed32 - The offset of the first revision to be returned

query? string - A search query to filter the revisions

'limit? Signed32 - The maximum number of revisions to be returned

sap.signavio: ListObjectivesQueries

Represents the Queries record for the operation: listObjectives

Fields

size Signed32(default 10) - Page size (max 1000)

page Signed32(default 0) - Zero-based page index (0 = first page)

dollarCount boolean(default false) - Include approximate total count in response when true

sap.signavio: ListTasksHeaders

Represents the Headers record for the operation: listTasks

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListTasksQueries

Represents the Queries record for the operation: listTasks

Fields

pageLimit int(default 100) - Max number of items

include string(default "case") - tasks relationships to include (csv)

pageOffset int(default 0) - Page offset

filterAssigneeEmail? string - Filter by assignee

filterCaseId? string - Filter by case

filterCompleted? string - Filter by completed

fields string(default "id") - tasks field to include

filterId? string - Filter by id (csv)

sap.signavio: ListUsersHeaders

Represents the Headers record for the operation: listUsers

Fields

contentType "application/vnd.api+json"|"application/json" (default "application/vnd.api+json") - The content type of the request. Use application/vnd.api+json.

sap.signavio: ListUsersQueries

Represents the Queries record for the operation: listUsers

Fields

pageLimit int(default 100) - Max number of items

pageOffset int(default 0) - Page offset

filterId? string - Filter by id (csv)

sap.signavio: Measurement

Represents the measurement.

Fields

score Signed32 - The score

time string - The time

sap.signavio: MessagesInner

Represents the messages inner.

Fields

details? record {}[] - Additional details for this message

'type? string - The message itself

sap.signavio: Meta

Non-standard meta-information that can not be represented as an attribute or relationship

sap.signavio: MetaInfoRequest

Represents the meta info request.

Fields

stencilsetBindings string - JSON string representing stencilset bindings

parent string - Parent path of the meta information

nameDeDe? string - German name of the meta information

descriptionEnGb? string - English description of the meta information

descriptionEsEs? string - Spanish description of the meta information

name string - Name of the meta information

nameEsEs? string - Spanish name of the meta information

descriptionDeDe? string - German description of the meta information

isGlossaryDefinition boolean - Indicates if it is a glossary definition

nameEnGb? string - English name of the meta information

'type string - Type of the meta information

sap.signavio: MetaResponseItem

Represents the meta response item.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? MetaResponseItemRep - The representation payload

sap.signavio: MetaResponseItemRep

Represents the meta response item rep.

Fields

glossaryBindings? record {}[] - The glossary bindings

lineWrap? boolean - The line wrap

defaultValue? string - The default value

length? int - The length

description? string - The description

isGlossaryDefinition? boolean - The is glossary definition

nameEnGb? string - The name en gb

'type? string - The type

isList? boolean - The is list

multilanguage? boolean - The multilanguage

stencilsetBindings? StencilsetBinding[] - The stencilset bindings

nameDeDe? string - The name de de

'readonly? boolean - The readonly

name? string - The name

id? string - The unique identifier

sap.signavio: ModelInfoRequest

Represents the model info request.

Fields

parent? string - The parent

formats? record {} - The formats

grantedRevisionUser? string - The granted revision user

created? string - The created

author? string - The author

isLicensedStencilSet? boolean - The is licensed stencil set

grantedRevisionUserName? string - The granted revision user name

description? string - The description

'type? string - The type

authorCompany? string - The author company

revision? string - The revision

parentName? string - The parent name

authorName? string - The author name

isDeployed? boolean - The is deployed

name? string - The name

updated? string - The updated

status? V1modelmodelIdinfoStatus - The status

sap.signavio: ModelInfoResponse

Represents the model info response.

Fields

parent? string - The parent

formats? record {} - The formats

grantedRevisionUser? string - The granted revision user

isLicensedStencilSet? boolean - The is licensed stencil set

grantedRevisionUserName? string - The granted revision user name

description? string - The description

'type? string - The type

sriRevision? string - The sri revision

sriPath? string - The sri path

numberOfNewComments? int - The number of new comments

isDeployed? boolean - The is deployed

grantedRevision? string - The granted revision

rev? int - The rev

created? string - The created

author? string - The author

grantedRevisionDate? string - The granted revision date

sri? string - The sri

authorCompany? string - The author company

revision? string - The revision

parentName? string - The parent name

deleted? boolean - The deleted

authorName? string - The author name

name? string - The name

namespace? string - The namespace

comment? string - The comment

updated? string - The updated

status? V1modelmodelIdinfoStatus - The status

sap.signavio: ModelRepresentation

Represents the model representation.

Fields

allowedMimeTypeRegex? string - The allowed mime type regex

deleted? boolean - The deleted

visible? boolean - The visible

created? string - The created

name? string - The name

description? string - The description

'type? string - The type

sendingInterval? string - The sending interval

nameEn? string - The name en

sap.signavio: ModelRequest

Represents the model request.

Fields

jsonXml? string - The json xml

sap.signavio: ModelResourceResponse

Represents the model resource response.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? ModelRepresentation - The representation payload

sap.signavio: ModelResponse

Represents the model response.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? Rep - The representation payload

sap.signavio: ModelRevisionsResponse

Represents the model revisions response.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? V1modelmodelIdrevisionsRep - The representation payload

sap.signavio: MoveDirectoryRequest

Represents the move directory request.

Fields

parent? ObjectReference - The parent

sap.signavio: NPSMeasurement

Represents the NPS measurement.

Fields

Fields Included from *Measurement

score Signed32
time string
anydata...

detractors Signed32 - The detractors

promoters Signed32 - The promoters

passives Signed32 - The passives

sap.signavio: Objective

Represents the objective.

Fields

dateCreated OffsetDateTime - Date and time when the objective was created

name string - Name of the objective

description? string - Detailed description of the objective

attributes anydata[] - Additional objective attributes as raw JSON

sId string - Unique string identifier (sId) of the objective matching ^([A-Z][a-z]+)+_.+$

dateUpdated OffsetDateTime - Date and time when the objective was last updated

sap.signavio: ObjectivesResponse

Represents the objectives response.

Fields

count? int - The count

value? Objective[] - The value

sap.signavio: OdataOutput

OdataOutput represents an OData document according to version 4.0 of the JSON format specification. It can serialized into a JSON

Fields

atOdataNextLink? string? - A link to the next page of results

atOdataCount? int? - The total number of entities matching the request

atOdataContext string - The OData context URL for the response

value anydata[] - The value of the item

Represents the pagination.

Fields

next? string? - The next page of data

last? string? - The last page of data

prev? string? - The previous page of data

first? string? - The first page of data

sap.signavio: ProcessInsightsContext

Represents the process insights context.

Fields

systemId? UUID - The system id

processFlowId? string - The process flow id

contextInfo? string - The context info

phaseId? string - The phase id

sap.signavio: ProcessIntelligenceContext

Represents the process intelligence context.

Fields

canvasId? string - The canvas id

processId? string - The process id

widgetId? string - The widget id

canvasType? ProcessIntelligenceCanvasType - The canvas type

sap.signavio: PublishData

The data required to publish or unpublish an item; only models and files can be published

Fields

mode "publish"|"unpublish" - The mode of the item

models ObjectReference[] - The associated models

sap.signavio: QueryEntitySetQueries

Represents the Queries record for the operation: queryEntitySet

Fields

dollarDeltatoken? string - Not implemented

dollarTop? int - A positive integer value that specifies the maximum number of entries to return, reduced by the value of skiptoken

dollarFilter? string - A filter expression that all entries in the result set must match

dollarSkiptoken? string - 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 - Not implemented

dollarSearch? string - Not implemented

dollarExpand? string - Not implemented

skip? int - A positive integer value that specifies the number of entries to skip before returning the remainder

dollarFormat? string - 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 - System query option inlinecount. If specified, then the server will return the number of entries as an integer

dollarId? string - Not implemented

dollarSelect string[] - The list of properties that each returned entry will specify

sap.signavio: RenameDirectoryData

This object can contain dynamic localized 'name' variants with the locale as a suffix of the attribute, e.g. name_fr_fr, name_en_us, name_de_de, etc

Fields

name string - The name of the item

description string - A description of the item

sap.signavio: Rep

Represents the rep.

Fields

parent? string - The parent

formats? record {} - The formats

grantedRevisionUser? string - The granted revision user

isLicensedStencilSet? boolean - The is licensed stencil set

grantedRevisionUserName? string - The granted revision user name

description? string - The description

'type? string - The type

sriRevision? string - The sri revision

sriPath? string - The sri path

isDeployed? boolean - The is deployed

grantedRevision? string - The granted revision

rev? int - The rev

created? string - The created

author? string - The author

grantedRevisionDate? string - The granted revision date

sri? string - The sri

authorCompany? string - The author company

revision? string - The revision

parentName? string - The parent name

deleted? boolean - The deleted

authorName? string - The author name

name? string - The name

namespace? string - The namespace

comment? string - The comment

updated? string - The updated

status? Status - The status

sap.signavio: Representation

Represents the representation.

Fields

formats? record {} - The formats

attachments? anydata[] - The attachments

color? string - The color

hidden? boolean - The hidden

grantedRevisionUser? string - The granted revision user

workflowSyncUpToDate? boolean - The workflow sync up to date

publishingMode? string - Array of prefixed IDs of categories that have this category as parent category

grantedRevisionUserName? string - The granted revision user name

linkedCount? int - The linked count

description? string - The description

language? string - The language

childCategories? string[] - The child categories

occurrence? int - The occurrence

replacedItemIds? string[] - The replaced item ids

title? string - The title

childCategoryCount? int - The child category count

'type? string - The type

categoryName? string - The category name

headRevisionNum? int - The head revision num

linkedByCount? int - The linked by count

metaDataValues? record {} - The meta data values

isEnabledForDimensions? boolean - The is enabled for dimensions

id? string - The unique identifier

hasAttachments? boolean - The has attachments

glossaryId? string - ID of the workspaces's Dictionary (not relevant for API access)

'order? int - The order

headRevision? string - The head revision

grantedRevision? string - The granted revision

grantedRevisionNumber? int - The granted revision number

decisionInput? boolean - The decision input

isDimension? boolean - The is dimension

author? string - The author

grantedRevisionDate? string - The granted revision date

authorCompany? string - The author company

itemCount? int - The item count

isStandard? boolean - The is standard

workflowSyncEnabled? boolean - The workflow sync enabled

name? string - The name

oldCategory? string - If the category corresponds to one of the six standard categories, this field is set. For example, some reports consider the content of these categories. The following oldCategories exist:
- ORG_UNIT - Organizational units
- DOCUMENT - Documents
- ACTIVITY - Activities
- STATE - Events
- IT_SYSTEM - IT systems
- NONE - Everything else

parentCategory? string - The parent category

comment? string - The comment

decisionDataObjectKey? string - The decision data object key

category? string - The category

items? anydata[] - The items

updated? string - The updated

sendingInterval? string - The sending interval

linkingPublishedModelsUpdateMode? string - The linking published models update mode

sap.signavio: SearchQueries

Represents the Queries record for the operation: search

Fields

q string - The search term

types? string - List of content types the search should include, from MODEL, MODEL_REVISION, SHAPE, FILE, FILE_REVISION, DIR and COMMENT

offset? string - Index of first search result to return

contentmode? string - e.g. explorer

'limit? string - Maximum number of search results, up to 250

fieldsJson? string - Example: [{"id":"search.searchableFields.all","textQueries":[{"matching":"contains","text":"foo-bar"}]}]

sap.signavio: ServiceDocument

An OData service document. Details can be found in the OData JSON specification Can be serialized into JSON

Fields

atOdataContext string - The OData context URL for the response

value ServiceDocumentEntity[] - The value of the item

sap.signavio: ServiceDocumentEntity

An entry in the OData service document. Details can be found in the OData JSON specification

Fields

kind string - The kind of the item

name string - The name of the item

url string - The URL of the item

sap.signavio: Spmv1glossaryAttachments

Represents the spmv1glossary attachments.

Fields

label? string - The label

url? string - The url

sap.signavio: Status

Represents the status.

Fields

deleted? boolean - The deleted

approve? boolean - The approve

publish? boolean - The publish

id? string - The unique identifier

sap.signavio: StencilsetBinding

Represents the stencilset binding.

Fields

namespace? string - The namespace

stencil? string - The stencil

'order? int - The order

sap.signavio: Success

A JSON:API document with a single resource

Fields

jsonapi? JsonApi - The JSON:API version information

meta? Meta - Non-standard meta-information that can not be represented as an attribute or relationship

links? Links - Link members related to the primary data

included? SuccessIncluded[] - Included resources

sap.signavio: SuccessIncluded

Represents the success included.

Fields

attributes? record {} - The attributes

id? string - The JSON:API resource ID

'type? string - The JSON:API resource type

sap.signavio: SuccessResponse

Represents the success response.

Fields

success? boolean - The success

sap.signavio: SyntaxCheckRepresentation

Represents the syntax check representation.

Fields

should? record {} - The should

must? record { string[]... } - The must

guidelineId? string - The guideline id

sap.signavio: SyntaxCheckRequest

Represents the syntax check request.

Fields

'resource? string - The resource

ns? string - The ns

isJson? boolean - The is json

context? string - The context

dataJson? string - JSON representation of your model as a string

sap.signavio: SyntaxCheckResponse

Represents the syntax check response.

Fields

rel? string - The relation type

href? string - The hypermedia link

rep? SyntaxCheckRepresentation[] - The representation payload

sap.signavio: Tag

Represents the tag.

Fields

dateCreated OffsetDateTime - The date created

id UUID - The unique identifier

label string - The label

dateUpdated OffsetDateTime - The date updated

sap.signavio: TasksAssigneeResourceAttribute

Represents the tasks assignee resource attribute.

Fields

name? string - The name

email? string - The email

sap.signavio: TasksIdResourceAttribute

The JSON:API resource ID

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: TasksResourceAttributes

Represents the tasks resource attributes.

Fields

attributes? TasksResourceAttributesAttributes - The attributes

sap.signavio: TasksResourceAttributesAttributes

Represents the tasks resource attributes attributes.

Fields

due? TasksDueResourceAttribute? - The due

created? TasksCreatedResourceAttribute? - The created

name? TasksNameResourceAttribute? - The name

assignee? TasksAssigneeResourceAttribute? - The assignee

completed? TasksCompletedResourceAttribute? - The completed

updated? TasksUpdatedResourceAttribute? - The updated

case? TasksCaseResourceAttribute - The case

applicationLink? TasksApplicationLinkResourceAttribute? - The application link

sap.signavio: TasksResourceReference

Represents the tasks resource reference.

Fields

id TasksIdResourceAttribute - The JSON:API resource ID

'type "Tasks" - The JSON:API resource type (Tasks)

sap.signavio: TasksResourceReferencesResponseSchema

Represents the tasks resource references response schema.

Fields

data? TasksResourceReference[] - The data

sap.signavio: TasksResourceResponseSchema

Represents the tasks resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data TasksResourceSchema - The data

sap.signavio: TasksResourceSchema

Represents the tasks resource schema.

Fields

Fields Included from *TasksResourceReference

id TasksIdResourceAttribute
type "Tasks"
anydata...

Fields Included from *TasksResourceAttributes

attributes TasksResourceAttributesAttributes
anydata...

attributes TasksResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: TasksResourcesResponseSchema

Represents the tasks resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data TasksResourceSchema[] - The data

sap.signavio: TokenRequest

Represents the token request.

Fields

password string - Authenticating user's password

name string - Authenticating user's email address

tokenonly boolean - Must be set to retrieve the JWT

tenant? string - Unique identifier of the target workspace. Only necessary if the authenticating user is a member of multiple workspaces

sap.signavio: UpdateDictionaryCategoryHeaders

Represents the Headers record for the operation: updateDictionaryCategory

Fields

contentType string(default "application/x-www-form-urlencoded") - application/x-www-form-urlencoded

sap.signavio: UpdateDictionaryEntryHeaders

Represents the Headers record for the operation: updateDictionaryEntry

sap.signavio: UpdateModelQueries

Represents the Queries record for the operation: updateModel

Fields

dc? string - A timestamp or unique string used to prevent caching issues

sap.signavio: UploadSchemaAndDataResponseDto

Represents the upload schema and data response dto.

Fields

executionId string - The execution id

sap.signavio: UserInfo

Represents the user info.

Fields

firstName? string - The first name

lastName? string - The last name

displayName? string - The display name

id UUID - The unique identifier

userGroupIds UserInfoUserGroupIdsItemsString[] - The user group ids

email? string - The email

sap.signavio: UsersIdResourceAttribute

The JSON:API resource ID

Fields

date? string - The date

timestamp? Signed32 - The timestamp (epoch seconds)

sap.signavio: UsersResourceAttributes

Represents the users resource attributes.

Fields

attributes? UsersResourceAttributesAttributes - The attributes

sap.signavio: UsersResourceAttributesAttributes

Represents the users resource attributes attributes.

Fields

name? UsersNameResourceAttribute? - The name

email? UsersEmailResourceAttribute? - The email

sap.signavio: UsersResourceReference

Represents the users resource reference.

Fields

id UsersIdResourceAttribute - The JSON:API resource ID

'type "Users" - The JSON:API resource type (Users)

sap.signavio: UsersResourceReferencesResponseSchema

Represents the users resource references response schema.

Fields

data? UsersResourceReference[] - The data

sap.signavio: UsersResourceResponseSchema

Represents the users resource response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data UsersResourceSchema - The data

sap.signavio: UsersResourceSchema

Represents the users resource schema.

Fields

Fields Included from *UsersResourceReference

id UsersIdResourceAttribute
type "Users"
anydata...

Fields Included from *UsersResourceAttributes

attributes UsersResourceAttributesAttributes
anydata...

attributes UsersResourceAttributesAttributes - The attributes

relationships? record {} - The relationships

links? record {} - The links

sap.signavio: UsersResourcesResponseSchema

Represents the users resources response schema.

Fields

Fields Included from *Success

jsonapi JsonApi
meta Meta
links Links
included SuccessIncluded[]
anydata...

data UsersResourceSchema[] - The data

sap.signavio: V1modelmodelIdinfoStatus

Represents the v1modelmodel idinfo status.

Fields

deleted? boolean - The deleted

approve? boolean - The approve

publish? boolean - The publish

id? string - The unique identifier

sap.signavio: V1modelmodelIdrevisionsRep

Represents the v1modelmodel idrevisions rep.

Fields

rev? int - The rev

size? int - The size

author? string - The author

authorName? string - The author name

created? string - The created

isDeployed? boolean - The is deployed

comment? string - The comment

authorCompany? string - The author company

status? string - The status

Union types

sap.signavio: ValueDriver

ValueDriver

Represents the value driver.

sap.signavio: InitiativeType

"STANDARD"|"PINT_MANAGED"

InitiativeType

Represents the initiative type.

sap.signavio: AuthorizationType

"USER"|"GROUP"

AuthorizationType

Represents the authorization type.

sap.signavio: InsightsValueDriver

InsightsValueDriver

Represents the insights value driver.

sap.signavio: Role

"OWNER"|"EDITOR"|"VIEWER"

Role

Represents the role.

sap.signavio: ProcessIntelligenceCanvasType

"INVESTIGATION"|"DASHBOARD"

ProcessIntelligenceCanvasType

Represents the process intelligence canvas type.

sap.signavio: InsightStatus

"OPEN"|"IN_PROGRESS"|"RESOLVED"

InsightStatus

Represents the insight status.

sap.signavio: InitiativeStatus

InitiativeStatus

Represents the initiative status.

sap.signavio: AssetType

AssetType

Represents the asset type.

Array types

sap.signavio: GroupsUsersResourceAttribute

UsersResourceReference[]?

GroupsUsersResourceAttribute

Represents the groups users resource attribute.

sap.signavio: CasesTasksResourceAttribute

TasksResourceReference[]?

CasesTasksResourceAttribute

Represents the cases tasks resource attribute.

sap.signavio: CaseVariablesValuesResourceAttribute

record {}[]?

CaseVariablesValuesResourceAttribute

Represents the case variables values resource attribute.

sap.signavio: Messages

MessagesInner[]

Messages

Represents the messages.

sap.signavio: CaseVariablesDefaultValuesResourceAttribute

record {}[]?

CaseVariablesDefaultValuesResourceAttribute

Represents the case variables default values resource attribute.

sap.signavio: CasesVariablesResourceAttribute

CaseVariablesResourceReference[]?

Simple name reference types

sap.signavio: CasesCreatorResourceAttribute

UsersResourceReference

CasesCreatorResourceAttribute

Represents the cases creator resource attribute.

sap.signavio: CasesCaseNumberResourceAttribute

Signed32?

CasesCaseNumberResourceAttribute

Represents the cases case number resource attribute.

sap.signavio: TasksCaseResourceAttribute

CasesResourceReference

TasksCaseResourceAttribute

Represents the tasks case resource attribute.

sap.signavio: CaseVariablesCaseResourceAttribute

CasesResourceReference

CaseVariablesCaseResourceAttribute

Represents the case variables case resource attribute.

sap.signavio: CasesPriorityResourceAttribute

Signed32?

CasesPriorityResourceAttribute

Represents the cases priority resource attribute.

sap.signavio: FilesSizeResourceAttribute

Signed32

FilesSizeResourceAttribute

Represents the files size resource attribute.

Import

import ballerinax/sap.signavio;

Other versions

1.0.0

Metadata

Released date: 9 days ago

Version: 1.0.0

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes

Pull count

Total: 1

Current verison: 1

Weekly downloads

Source repository

Keywords

Cost/Paid

Vendor/SAP

Area/ERP & Business Operations

Type/Connector

Contributors

Dependencies

ballerina/constraint/1.7.0 ballerina/os/1.10.1 ballerina/data.jsondata/1.1.3

Cookie policy

Delete policy

clients

records

unionTypes

arrayTypes

stringTypes

integerTypes

simpleNameReferenceTypes

ballerinax/sap.signavio Ballerina library

Overview

Setup guide

Quickstart

Step 1: Import the module

Step 2: Instantiate a new connector

Step 3: Invoke the connector operation

Step 4: Run the Ballerina application

Examples

Clients

sap.signavio: Client

Constructor

listCaseVariables

Parameters

Return Type

getCaseVariable

Parameters

Return Type

listCaseVariableCases

Parameters

Return Type

listCaseVariableCaseRefs

Parameters

Return Type

listCases

Parameters

Return Type

getCase

Parameters

Return Type

listCaseTasks

Parameters

Return Type

getCaseCreator

Parameters

Return Type

listFiles

Parameters

Return Type

getFile

Parameters

Return Type

listGroups

Parameters

Return Type

getGroup

Parameters

Return Type

listGroupUserRefs

Parameters

Return Type

listGroupUsers

Parameters

Return Type

listTasks

Parameters

Return Type

getTask

Parameters

Return Type

getTaskCase

Parameters

Return Type

getTaskCaseRef

Parameters

Return Type

listUsers

Parameters

Return Type

getUser

Parameters

Return Type

addAutomaticMeasurementToMetric