Package org.flowable.rest.service.api

Class RestUrls

  • public final class RestUrls
extends Object
    Author:
    Frederik Heremans

    • Field Detail

      • SEGMENT_REPOSITORY_RESOURCES

        public static final String SEGMENT_REPOSITORY_RESOURCES
        Base segment for all repository-related resources: repository
        See Also:
        Constant Field Values

      • SEGMENT_DEPLOYMENT_ARTIFACT_RESOURCE

        public static final String SEGMENT_DEPLOYMENT_ARTIFACT_RESOURCE
        See Also:
        Constant Field Values

      • SEGMENT_DEPLOYMENT_ARTIFACT_RESOURCE_CONTENT

        public static final String SEGMENT_DEPLOYMENT_ARTIFACT_RESOURCE_CONTENT
        See Also:
        Constant Field Values

      • SEGMENT_HISTORIC_PROCESS_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_PROCESS_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • SEGMENT_HISTORIC_TASK_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_TASK_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • SEGMENT_HISTORIC_ACTIVITY_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_ACTIVITY_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • SEGMENT_HISTORIC_VARIABLE_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_VARIABLE_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • URL_DEPLOYMENT_COLLECTION

        public static final String[] URL_DEPLOYMENT_COLLECTION
        URL template for the deployment collection: repository/deployments

      • URL_DEPLOYMENT

        public static final String[] URL_DEPLOYMENT
        URL template for a single deployment: repository/deployments/{0:deploymentId}

      • URL_DEPLOYMENT_RESOURCES

        public static final String[] URL_DEPLOYMENT_RESOURCES
        URL template listing deployment resources: repository/deployments/{0:deploymentId}/resources

      • URL_DEPLOYMENT_RESOURCE

        public static final String[] URL_DEPLOYMENT_RESOURCE
        URL template for a single deployment resource: repository/deployments/{0:deploymentId}/resources/{1}:resourceId

      • URL_DEPLOYMENT_RESOURCE_CONTENT

        public static final String[] URL_DEPLOYMENT_RESOURCE_CONTENT
        URL template for a single deployment resource content: repository/deployments /{0:deploymentId}/resourcedata/{1}:resourceId

      • URL_PROCESS_DEFINITION_COLLECTION

        public static final String[] URL_PROCESS_DEFINITION_COLLECTION
        URL template for the process definition collection: repository/process-definitions

      • URL_PROCESS_DEFINITION

        public static final String[] URL_PROCESS_DEFINITION
        URL template for a single process definition: repository/process-definitions/{0:processDefinitionId}

      • URL_PROCESS_DEFINITION_RESOURCE_CONTENT

        public static final String[] URL_PROCESS_DEFINITION_RESOURCE_CONTENT
        URL template for the resource of a single process definition: repository /process-definitions/{0:processDefinitionId}/resourcedata

      • URL_PROCESS_DEFINITION_IDENTITYLINKS_COLLECTION

        public static final String[] URL_PROCESS_DEFINITION_IDENTITYLINKS_COLLECTION
        URL template for a process definition's identity links: repository/process -definitions/{0:processDefinitionId}/identitylinks

      • URL_PROCESS_DEFINITION_IDENTITYLINK

        public static final String[] URL_PROCESS_DEFINITION_IDENTITYLINK
        URL template for an identitylink on a process definition: repository/process -definitions/{0:processDefinitionId}/identitylinks/{1 :family}/{2:identityId}

      • URL_PROCESS_DEFINITION_MODEL

        public static final String[] URL_PROCESS_DEFINITION_MODEL
        URL template for the model of a process definition: repository/process-definitions/{0:processDefinitionId}/model

      • URL_PROCESS_DEFINITION_IMAGE

        public static final String[] URL_PROCESS_DEFINITION_IMAGE
        URL template for the image of a process definition: repository/process-definitions/{0:processDefinitionId}/image

      • URL_PROCESS_DEFINITION_START_FORM

        public static final String[] URL_PROCESS_DEFINITION_START_FORM
        URL template for the start form of a process definition: repository/process-definitions/{0:processDefinitionId}/start-form

      • URL_PROCESS_DEFINITION_DECISION_COLLECTION

        public static final String[] URL_PROCESS_DEFINITION_DECISION_COLLECTION
        URL template for the image of a process definition: repository/process-definitions/{0:processDefinitionId}/decisions

      • URL_PROCESS_DEFINITION_FORM_DEFINITIONS_COLLECTION

        public static final String[] URL_PROCESS_DEFINITION_FORM_DEFINITIONS_COLLECTION
        URL template for the image of a process definition: repository/process-definitions/{0:processDefinitionId}/form-definitions

      • URL_MODEL_COLLECTION

        public static final String[] URL_MODEL_COLLECTION
        URL template for the model collection: repository/models

      • URL_MODEL

        public static final String[] URL_MODEL
        URL template for a single model repository/models/{0:modelId}

      • URL_MODEL_SOURCE

        public static final String[] URL_MODEL_SOURCE
        URL template for the editor source of a model repository/models/{0:modelId}/source

      • URL_MODEL_SOURCE_EXTRA

        public static final String[] URL_MODEL_SOURCE_EXTRA
        URL template for the extra editor source of a model repository/models/{0:modelId}/source-extra

      • URL_TASK_COLLECTION

        public static final String[] URL_TASK_COLLECTION
        URL template for task collection: runtime/tasks

      • URL_TASK_QUERY

        public static final String[] URL_TASK_QUERY
        URL template for task query: query/tasks

      • URL_TASK

        public static final String[] URL_TASK
        URL template for a single task: runtime/tasks/{0:taskId}

      • URL_TASK_SUBTASKS_COLLECTION

        public static final String[] URL_TASK_SUBTASKS_COLLECTION
        URL template for a task's sub tasks: runtime/tasks/{0:taskId}/subtasks

      • URL_TASK_VARIABLES_COLLECTION

        public static final String[] URL_TASK_VARIABLES_COLLECTION
        URL template for a task's variables: runtime/tasks/{0:taskId}/variables

      • URL_TASK_VARIABLE

        public static final String[] URL_TASK_VARIABLE
        URL template for a single task variable: runtime/tasks/{0:taskId}/variables/{1:variableName}

      • URL_TASK_VARIABLE_DATA

        public static final String[] URL_TASK_VARIABLE_DATA
        URL template for a single task variable content: runtime/tasks/{0:taskId}/variables/{1:variableName}/data

      • URL_TASK_IDENTITYLINKS_COLLECTION

        public static final String[] URL_TASK_IDENTITYLINKS_COLLECTION
        URL template for a task's identity links: runtime/tasks/{0:taskId}/identitylinks

      • URL_TASK_IDENTITYLINK

        public static final String[] URL_TASK_IDENTITYLINK
        URL template for an identitylink on a task: runtime/tasks/{0:taskId}/identitylinks /{1:family}/{2:identityId}/{3:type}

      • URL_TASK_FORM

        public static final String[] URL_TASK_FORM
        URL template for a task form: runtime/tasks/{0:taskId}/form

      • URL_TASK_COMMENT_COLLECTION

        public static final String[] URL_TASK_COMMENT_COLLECTION
        URL template for a task's identity links: runtime/tasks/{0:taskId}/comments

      • URL_TASK_COMMENT

        public static final String[] URL_TASK_COMMENT
        URL template for a comment on a task: runtime/tasks/{0:taskId}/comments/{1:commentId}

      • URL_TASK_EVENT_COLLECTION

        public static final String[] URL_TASK_EVENT_COLLECTION
        URL template for an task's events: runtime/tasks/{0:taskId}/events

      • URL_TASK_EVENT

        public static final String[] URL_TASK_EVENT
        URL template for an event on a task: runtime/tasks/{0:taskId}/events/{1:eventId}

      • URL_TASK_ATTACHMENT_COLLECTION

        public static final String[] URL_TASK_ATTACHMENT_COLLECTION
        URL template for an task's attachments: runtime/tasks/{0:taskId}/attachments

      • URL_TASK_ATTACHMENT

        public static final String[] URL_TASK_ATTACHMENT
        URL template for an attachment on a task: runtime/tasks/{0:taskId}/attachments/{1:attachmentId}

      • URL_TASK_ATTACHMENT_DATA

        public static final String[] URL_TASK_ATTACHMENT_DATA
        URL template for the content for an attachment on a task: runtime/tasks/{0:taskId}/attachments/{1:attachmentId}/content

      • URL_EXECUTION_COLLECTION

        public static final String[] URL_EXECUTION_COLLECTION
        URL template for execution collection: runtime/executions/{0:executionId}

      • URL_EXECUTION

        public static final String[] URL_EXECUTION
        URL template for a single execution: runtime/executions/{0:executionId}

      • URL_EXECUTION_VARIABLE_COLLECTION

        public static final String[] URL_EXECUTION_VARIABLE_COLLECTION
        URL template for the variables for an execution: runtime/executions/{0:executionId}/variables

      • URL_EXECUTION_VARIABLE

        public static final String[] URL_EXECUTION_VARIABLE
        URL template for a single variables for an execution: runtime/executions/{0:executionId}/variables/{1:variableName}

      • URL_EXECUTION_VARIABLE_DATA

        public static final String[] URL_EXECUTION_VARIABLE_DATA
        URL template for a single variables for an execution: runtime/executions/{0:executionId}/variables/{1:variableName}/data

      • URL_EXECUTION_ACTIVITIES_COLLECTION

        public static final String[] URL_EXECUTION_ACTIVITIES_COLLECTION
        URL template for all active activities on an execution: runtime/executions/{0:executionId}/activities

      • URL_EXECUTION_QUERY

        public static final String[] URL_EXECUTION_QUERY
        URL template for execution query: query/executions

      • URL_ACTIVITY_INSTANCES

        public static final String[] URL_ACTIVITY_INSTANCES
        URL template for activity instance query: runtime/activity-instances

      • URL_ACTIVITY_INSTANCE_QUERY

        public static final String[] URL_ACTIVITY_INSTANCE_QUERY
        URL template for activity instance query: query/activity-instances

      • URL_PROCESS_INSTANCE_COLLECTION

        public static final String[] URL_PROCESS_INSTANCE_COLLECTION
        URL template for process instance collection: runtime/process-instances

      • URL_PROCESS_INSTANCE_QUERY

        public static final String[] URL_PROCESS_INSTANCE_QUERY
        URL template for process instance query: query/process-instances

      • URL_PROCESS_INSTANCE

        public static final String[] URL_PROCESS_INSTANCE
        URL template for a single process instance: runtime/process-instances/{0:processInstanceId}

      • URL_PROCESS_INSTANCE_DIAGRAM

        public static final String[] URL_PROCESS_INSTANCE_DIAGRAM
        URL template for the diagram for a single process instance: runtime/process-instances/{0:processInstanceId}/diagram

      • URL_PROCESS_INSTANCE_VARIABLE_COLLECTION

        public static final String[] URL_PROCESS_INSTANCE_VARIABLE_COLLECTION
        URL template for process instance variable collection: runtime/process-instances/{0:processInstanceId}/variables

      • URL_PROCESS_INSTANCE_VARIABLE

        public static final String[] URL_PROCESS_INSTANCE_VARIABLE
        URL template for a single process instance variable: runtime/process-instances /{0:processInstanceId}/variables/{1:variableName}

      • URL_PROCESS_INSTANCE_VARIABLE_DATA

        public static final String[] URL_PROCESS_INSTANCE_VARIABLE_DATA
        URL template for a single process instance variable data: runtime/process -instances/{0:processInstanceId}/variables/{1:variableName}/data

      • URL_VARIABLE_INSTANCES

        public static final String[] URL_VARIABLE_INSTANCES
        URL template for variable instance query: runtime/variable-instances

      • URL_VARIABLE_INSTANCE_DATA

        public static final String[] URL_VARIABLE_INSTANCE_DATA
        URL template for a single variable instance data: runtime/variable-instances/{0:varInstanceId}/data

      • URL_VARIABLE_INSTANCE_QUERY

        public static final String[] URL_VARIABLE_INSTANCE_QUERY
        URL template for variable instance query: query/variable-instances

      • URL_HISTORIC_PROCESS_INSTANCE_COMMENT

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE_COMMENT
        URL template for a comment on a process instance: history/historic-process -instances/{0:processInstanceId}/comments/{1:commentId}

      • URL_HISTORIC_PROCESS_INSTANCE_COMMENT_COLLECTION

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE_COMMENT_COLLECTION
        URL template for comments on a process instance: history/historic-process-instances/{0:processInstanceId}/comments

      • URL_PROCESS_INSTANCE_IDENTITYLINKS_COLLECTION

        public static final String[] URL_PROCESS_INSTANCE_IDENTITYLINKS_COLLECTION
        URL template for a process instance's identity links: runtime/process-instances/{0:processInstanceId}/identitylinks

      • URL_PROCESS_INSTANCE_IDENTITYLINK

        public static final String[] URL_PROCESS_INSTANCE_IDENTITYLINK
        URL template for an identitylink on a process instance: runtime/process -instances/{0:processInstanceId}/identitylinks/users/{1: identityId}/{2:type}

      • URL_HISTORIC_PROCESS_INSTANCE

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE
        URL template for a single historic process instance: history/historic-process-instances/{0:processInstanceId}

      • URL_HISTORIC_PROCESS_INSTANCES

        public static final String[] URL_HISTORIC_PROCESS_INSTANCES
        URL template for historic process instance query: history/historic-process-instances

      • URL_HISTORIC_PROCESS_INSTANCE_IDENTITY_LINKS

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE_IDENTITY_LINKS
        URL template for historic process instance identity links: history/historic -process-instances/{0:processInstanceId}/identitylinks

      • URL_HISTORIC_PROCESS_INSTANCE_VARIABLE_DATA

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE_VARIABLE_DATA
        URL template for a single historic task instance: history/historic-process -instances/{0:processInstanceId}/variables/{1:variableName}

      • URL_HISTORIC_TASK_INSTANCE

        public static final String[] URL_HISTORIC_TASK_INSTANCE
        URL template for a single historic task instance: history/historic-task-instances/{0:taskId}

      • URL_HISTORIC_TASK_INSTANCES

        public static final String[] URL_HISTORIC_TASK_INSTANCES
        URL template for historic task instance query: history/historic-task-instances

      • URL_HISTORIC_TASK_INSTANCE_IDENTITY_LINKS

        public static final String[] URL_HISTORIC_TASK_INSTANCE_IDENTITY_LINKS
        URL template for historic task instance identity links: history/historic-task-instances/{0:taskId}/identitylinks

      • URL_HISTORIC_TASK_INSTANCE_VARIABLE_DATA

        public static final String[] URL_HISTORIC_TASK_INSTANCE_VARIABLE_DATA
        URL template for a single historic task instance: history/historic-task -instances/{0:taskId}/variables/{1:variableName}

      • URL_HISTORIC_TASK_INSTANCE_FORM

        public static final String[] URL_HISTORIC_TASK_INSTANCE_FORM
        URL template for a historic task instance form: history/historic-task-instances/{0:taskId}/form

      • URL_HISTORIC_TASK_LOG_ENTRIES

        public static final String[] URL_HISTORIC_TASK_LOG_ENTRIES
        URL template for a historic task log entries form: history/historic-task-log-entries

      • URL_HISTORIC_ACTIVITY_INSTANCES

        public static final String[] URL_HISTORIC_ACTIVITY_INSTANCES
        URL template for historic activity instance query: history/historic-activity-instances

      • URL_HISTORIC_VARIABLE_INSTANCES

        public static final String[] URL_HISTORIC_VARIABLE_INSTANCES
        URL template for historic variable instance query: history/historic-variable-instances

      • URL_HISTORIC_VARIABLE_INSTANCE_DATA

        public static final String[] URL_HISTORIC_VARIABLE_INSTANCE_DATA
        URL template for a single historic variable instance data: history/historic-variable-instances/{0:varInstanceId}/data

      • URL_HISTORIC_DETAIL

        public static final String[] URL_HISTORIC_DETAIL
        URL template for historic detail query: history/historic-detail

      • URL_HISTORIC_DETAIL_VARIABLE_DATA

        public static final String[] URL_HISTORIC_DETAIL_VARIABLE_DATA
        URL template for a single historic detail variable data: history/historic-detail/{0:detailId}/data

      • URL_HISTORIC_PROCESS_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_PROCESS_INSTANCE_QUERY
        URL template for historic process instance query: query/historic-process-instances

      • URL_HISTORIC_TASK_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_TASK_INSTANCE_QUERY
        URL template for historic process instance query: query/historic-task-instances

      • URL_HISTORIC_ACTIVITY_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_ACTIVITY_INSTANCE_QUERY
        URL template for historic activity instance query: query/historic-activity-instances

      • URL_HISTORIC_VARIABLE_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_VARIABLE_INSTANCE_QUERY
        URL template for historic variable instance query: query/historic-variable-instances

      • URL_HISTORIC_DETAIL_QUERY

        public static final String[] URL_HISTORIC_DETAIL_QUERY
        URL template for historic detail query: query/historic-detail

      • URL_TABLES_COLLECTION

        public static final String[] URL_TABLES_COLLECTION
        URL template for the collection of tables: management/tables

      • URL_ENGINE_PROPERTIES

        public static final String[] URL_ENGINE_PROPERTIES
        URL template for the collection of engine properties: management/engine-properties

      • URL_FORM_DATA

        public static final String[] URL_FORM_DATA
        URL template for form data: form/form-data

      • URL_TABLE

        public static final String[] URL_TABLE
        URL template for a single table: management/tables/{0:tableName}

      • URL_TABLE_COLUMNS

        public static final String[] URL_TABLE_COLUMNS
        URL template for column-metadata for a single table: management/tables/{0:tableName}/columns

      • URL_TABLE_DATA

        public static final String[] URL_TABLE_DATA
        URL template for actual table row data: management/tables/{0:tableName}/data

      • URL_JOB

        public static final String[] URL_JOB
        URL template for a single job: management/jobs/{0:jobId}

      • URL_TIMER_JOB

        public static final String[] URL_TIMER_JOB
        URL template for a single job: management/timer-jobs/{0:jobId}

      • URL_SUSPENDED_JOB

        public static final String[] URL_SUSPENDED_JOB
        URL template for a single job: management/suspended-jobs/{0:jobId}

      • URL_DEADLETTER_JOB

        public static final String[] URL_DEADLETTER_JOB
        URL template for a single job: management/deadletter-jobs/{0:jobId}

      • URL_HISTORY_JOB

        public static final String[] URL_HISTORY_JOB
        URL template for a single job: management/history-jobs/{0:jobId}

      • URL_JOB_EXCEPTION_STRACKTRACE

        public static final String[] URL_JOB_EXCEPTION_STRACKTRACE
        URL template for the stacktrace of a single job: management/jobs/{0:jobId}/exception-stacktrace

      • URL_TIMER_JOB_EXCEPTION_STRACKTRACE

        public static final String[] URL_TIMER_JOB_EXCEPTION_STRACKTRACE
        URL template for the stacktrace of a single job: management/timer-jobs/{jobId}/exception-stacktrace

      • URL_SUSPENDED_JOB_EXCEPTION_STRACKTRACE

        public static final String[] URL_SUSPENDED_JOB_EXCEPTION_STRACKTRACE
        URL template for the stacktrace of a single job: management/suspended-jobs/{0:jobId}/exception-stacktrace

      • URL_DEADLETTER_JOB_EXCEPTION_STRACKTRACE

        public static final String[] URL_DEADLETTER_JOB_EXCEPTION_STRACKTRACE
        URL template for the stacktrace of a single job: management/deadletter-jobs/{0:jobId}/exception-stacktrace

      • URL_JOB_COLLECTION

        public static final String[] URL_JOB_COLLECTION
        URL template for the collection of jobs: management/jobs

      • URL_TIMER_JOB_COLLECTION

        public static final String[] URL_TIMER_JOB_COLLECTION
        URL template for the collection of timer jobs: management/timer-jobs

      • URL_SUSPENDED_JOB_COLLECTION

        public static final String[] URL_SUSPENDED_JOB_COLLECTION
        URL template for the collection of timer jobs: management/suspended-jobs

      • URL_DEADLETTER_JOB_COLLECTION

        public static final String[] URL_DEADLETTER_JOB_COLLECTION
        URL template for the collection of timer jobs: management/deadletter-jobs

      • URL_BATCH

        public static final String[] URL_BATCH
        URL template for a single batch: management/batches/{0:batchId}

      • URL_BATCH_COLLECTION

        public static final String[] URL_BATCH_COLLECTION
        URL template for the collection of batches: management/batches

      • URL_BATCH_PART

        public static final String[] URL_BATCH_PART
        URL template for a single batch part: management/batches/{0:batchId}

      • URL_BATCH_PART_COLLECTION

        public static final String[] URL_BATCH_PART_COLLECTION
        URL template for the collection of batches: management/batches/{0:batchId}/batch-parts

      • URL_EVENT_SUBSCRIPTION

        public static final String[] URL_EVENT_SUBSCRIPTION
        URL template for a single event subscription: runtime/event-subscriptions/{0:eventSubscriptionId}

      • URL_EVENT_SUBSCRIPTION_COLLECTION

        public static final String[] URL_EVENT_SUBSCRIPTION_COLLECTION
        URL template for the collection of event subscriptions: runtime/event-subscriptions

      • URL_PROPERTIES_COLLECTION

        public static final String[] URL_PROPERTIES_COLLECTION
        URL template for the collection of properties: management/properties

      • URL_ENGINE_INFO

        public static final String[] URL_ENGINE_INFO
        URL template for the collection of properties: management/properties

      • URL_USER_COLLECTION

        public static final String[] URL_USER_COLLECTION
        URL template for the collection of users: identity/users

      • URL_USER

        public static final String[] URL_USER
        URL template for a single user: identity/users/{0:userId}

      • URL_USER_PICTURE

        public static final String[] URL_USER_PICTURE
        URL template for the picture for a single user: identity/users/{0:userId}/picture

      • URL_USER_INFO

        public static final String[] URL_USER_INFO
        URL template for an info entry for a single user: identity/users/{0:userId}/info/{1:key}

      • URL_USER_INFO_COLLECTION

        public static final String[] URL_USER_INFO_COLLECTION
        URL template for the info collection for a single user: identity/users/{0:userId}/info

      • URL_GROUP_COLLECTION

        public static final String[] URL_GROUP_COLLECTION
        URL template for the collection of groups: identity/groups

      • URL_GROUP

        public static final String[] URL_GROUP
        URL template for a single group: identity/groups/{0:groupId}

      • URL_GROUP_MEMBERSHIP_COLLECTION

        public static final String[] URL_GROUP_MEMBERSHIP_COLLECTION
        URL template for the membership-collection of a group: identity/groups/{0:groupId}/members

      • URL_GROUP_MEMBERSHIP

        public static final String[] URL_GROUP_MEMBERSHIP
        URL template for the membership-collection of a single group membership: identity/groups/{0:groupId}/members/{1:userId}

      • URL_SIGNALS

        public static final String[] URL_SIGNALS
        URL template for a signals runtime/signals

    • Constructor Detail

      • RestUrls

        public RestUrls()

    • Method Detail

      • createRelativeResourceUrl

        public static String createRelativeResourceUrl​(String[] segments,
                                               Object... arguments)
        Creates an url based on the passed fragments and replaces any placeholders with the given arguments. The placeholders are following the MessageFormat convention (eg. {0} is replaced by first argument value).