Package org.flowable.cmmn.rest.service.api

Class CmmnRestUrls

  • public final class CmmnRestUrls
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_CASE_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_CASE_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

      • SEGMENT_HISTORIC_MILESTONE_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_MILESTONE_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • SEGMENT_HISTORIC_PLANITEM_INSTANCE_RESOURCE

        public static final String SEGMENT_HISTORIC_PLANITEM_INSTANCE_RESOURCE
        See Also:
        Constant Field Values

      • URL_DEPLOYMENT_COLLECTION

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

      • URL_DEPLOYMENT

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

      • URL_DEPLOYMENT_RESOURCES

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

      • URL_DEPLOYMENT_RESOURCE

        public static final String[] URL_DEPLOYMENT_RESOURCE
        URL template for a single deployment resource: cmmn-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: cmmn-repository/deployments /{0:deploymentId}/resourcedata/{1}:resourceId

      • URL_CASE_DEFINITION_COLLECTION

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

      • URL_CASE_DEFINITION

        public static final String[] URL_CASE_DEFINITION
        URL template for a single case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}

      • URL_CASE_DEFINITION_RESOURCE_CONTENT

        public static final String[] URL_CASE_DEFINITION_RESOURCE_CONTENT
        URL template for the resource of a single case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/resourcedata

      • URL_CASE_DEFINITION_IDENTITYLINKS_COLLECTION

        public static final String[] URL_CASE_DEFINITION_IDENTITYLINKS_COLLECTION
        URL template for a case definition's identity links: cmmn-repository/case-definitions/{0:caseDefinitionId}/identitylinks

      • URL_CASE_DEFINITION_IDENTITYLINK

        public static final String[] URL_CASE_DEFINITION_IDENTITYLINK
        URL template for an identitylink on a case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/identitylinks/{1 :family}/{2:identityId}

      • URL_CASE_DEFINITION_START_FORM

        public static final String[] URL_CASE_DEFINITION_START_FORM
        URL template for the start form of a case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/start-form

      • URL_CASE_DEFINITION_IMAGE

        public static final String[] URL_CASE_DEFINITION_IMAGE
        URL template for the image of a case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/image

      • URL_CASE_DEFINITION_DECISION_COLLECTION

        public static final String[] URL_CASE_DEFINITION_DECISION_COLLECTION
        URL template for the image of a case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/decisions

      • URL_CASE_DEFINITION_FORM_DEFINITIONS_COLLECTION

        public static final String[] URL_CASE_DEFINITION_FORM_DEFINITIONS_COLLECTION
        URL template for the image of a case definition: cmmn-repository/case-definitions/{0:caseDefinitionId}/form-definitions

      • 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_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_CASE_INSTANCE_COLLECTION

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

      • URL_CASE_INSTANCE_QUERY

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

      • URL_CASE_INSTANCE

        public static final String[] URL_CASE_INSTANCE
        URL template for a single case instance: cmmn-runtime/case-instances/{0:caseInstanceId}

      • URL_CASE_INSTANCE_DIAGRAM

        public static final String[] URL_CASE_INSTANCE_DIAGRAM
        URL template for the diagram for a single CASE instance: cmmn-runtime/case-instances/{0:caseInstanceId}/diagram

      • URL_CASE_INSTANCE_VARIABLE_COLLECTION

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

      • URL_CASE_INSTANCE_VARIABLE

        public static final String[] URL_CASE_INSTANCE_VARIABLE
        URL template for a single case instance variable: cmmn-runtime/case-instances /{0:caseInstanceId}/variables/{1:variableName}

      • URL_CASE_INSTANCE_VARIABLE_DATA

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

      • URL_CASE_INSTANCE_STAGE_OVERVIEW

        public static final String[] URL_CASE_INSTANCE_STAGE_OVERVIEW
        URL template for a single case instance stage overview: cmmn-runtime/case-instances/{0:caseInstanceId}/stage-overview

      • URL_CASE_INSTANCE_CHANGE_STATE

        public static final String[] URL_CASE_INSTANCE_CHANGE_STATE
        URL template for a single case instance change state: cmmn-runtime/case-instances/{0:caseInstanceId}/change-state

      • URL_CASE_INSTANCE_IDENTITYLINKS_COLLECTION

        public static final String[] URL_CASE_INSTANCE_IDENTITYLINKS_COLLECTION
        URL template for a case instance's identity links: cmmn-runtime/case-instances/{0:caseInstanceId}/identitylinks

      • URL_CASE_INSTANCE_IDENTITYLINK

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

      • URL_PLAN_ITEM_INSTANCE_COLLECTION

        public static final String[] URL_PLAN_ITEM_INSTANCE_COLLECTION
        URL template for plan item instance collection: cmmn-runtime/plan-item-instances

      • URL_PLAN_ITEM_INSTANCE_QUERY

        public static final String[] URL_PLAN_ITEM_INSTANCE_QUERY
        URL template for process instance query: cmmn-query/plan-item-instances

      • URL_PLAN_ITEM_INSTANCE

        public static final String[] URL_PLAN_ITEM_INSTANCE
        URL template for a single case instance: cmmn-runtime/plan-item-instances/{0:planItemInstanceId}

      • URL_PLAN_ITEM_INSTANCE_VARIABLES

        public static final String[] URL_PLAN_ITEM_INSTANCE_VARIABLES
        URL template for plan item instance variables: cmmn-runtime/plan-item-instances/{0:planItemInstanceId}/variables

      • URL_PLAN_ITEM_INSTANCE_VARIABLE

        public static final String[] URL_PLAN_ITEM_INSTANCE_VARIABLE
        URL template for a single plan item instance variable: cmmn-runtime/plan-item-instances/{0:planItemInstanceId}/variables/{1:variableName}

      • URL_PLAN_ITEM_INSTANCE_VARIABLE_DATA

        public static final String[] URL_PLAN_ITEM_INSTANCE_VARIABLE_DATA
        URL template for a single case instance: cmmn-runtime/plan-item-instances/{0:planItemInstanceId}/variables/{1:variableName}/data

      • URL_VARIABLE_INSTANCES

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

      • URL_VARIABLE_INSTANCE_DATA

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

      • URL_JOB

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

      • URL_TIMER_JOB

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

      • URL_SUSPENDED_JOB

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

      • URL_DEADLETTER_JOB

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

      • URL_HISTORY_JOB

        public static final String[] URL_HISTORY_JOB
        URL template for a single job: cmmn-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: cmmn-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: cmmn-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: cmmn-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: cmmn-management/deadletter-jobs/{0:jobId}/exception-stacktrace

      • URL_JOB_COLLECTION

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

      • URL_TIMER_JOB_COLLECTION

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

      • URL_SUSPENDED_JOB_COLLECTION

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

      • URL_DEADLETTER_JOB_COLLECTION

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

      • URL_EVENT_SUBSCRIPTION

        public static final String[] URL_EVENT_SUBSCRIPTION
        URL template for a single event subscription: cmmn-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: cmmn-runtime/event-subscriptions

      • URL_HISTORIC_CASE_INSTANCE

        public static final String[] URL_HISTORIC_CASE_INSTANCE
        URL template for a single historic case instance: cmmn-history/historic-case-instances/{0:caseInstanceId}

      • URL_HISTORIC_CASE_INSTANCE_STAGE_OVERVIEW

        public static final String[] URL_HISTORIC_CASE_INSTANCE_STAGE_OVERVIEW
        URL template for a single historic case instance stage overview: cmmn-history/historic-case-instances/{0:caseInstanceId}/stage-overview

      • URL_HISTORIC_CASE_INSTANCES

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

      • URL_HISTORIC_CASE_INSTANCE_IDENTITY_LINKS

        public static final String[] URL_HISTORIC_CASE_INSTANCE_IDENTITY_LINKS
        URL template for historic case instance identity links: cmmn-history/historic-case-instances/{0:caseInstanceId}/identitylinks

      • URL_HISTORIC_CASE_INSTANCE_VARIABLE_DATA

        public static final String[] URL_HISTORIC_CASE_INSTANCE_VARIABLE_DATA
        URL template for historic case instance variables: history/historic-case-instances/{0:caseInstanceId}/variables/{1:variableName}/data

      • 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}/data

      • 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_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_VARIABLE_INSTANCE_QUERY

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

      • URL_HISTORIC_MILESTONE_INSTANCE

        public static final String[] URL_HISTORIC_MILESTONE_INSTANCE
        URL template for a single historic milestone instance: cmmn-history/historic-milestone-instances/{0:milestoneId}

      • URL_HISTORIC_MILESTONE_INSTANCES

        public static final String[] URL_HISTORIC_MILESTONE_INSTANCES
        URL template for a single historic milestone instance: cmmn-history/historic-milestone-instances

      • URL_HISTORIC_PLANITEM_INSTANCE

        public static final String[] URL_HISTORIC_PLANITEM_INSTANCE
        URL template for a single historic plan item instance: cmmn-history/historic-planitem-instances/{0:planItemId}

      • URL_HISTORIC_PLANITEM_INSTANCES

        public static final String[] URL_HISTORIC_PLANITEM_INSTANCES
        URL template for a single historic plan item instance: cmmn-history/historic-planitem-instances

      • URL_HISTORIC_CASE_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_CASE_INSTANCE_QUERY
        URL template for historic case instance query: query/historic-case-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_MILESTONE_INSTANCE_QUERY

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

      • URL_HISTORIC_PLANITEM_INSTANCE_QUERY

        public static final String[] URL_HISTORIC_PLANITEM_INSTANCE_QUERY
        URL template for historic plan item instance query: query/historic-planitem-instances

      • 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

    • Constructor Detail

      • CmmnRestUrls

        public CmmnRestUrls()

    • 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).