Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/v0v1/search

Operation Type

POST

Content-Type

application/json

...

Attribute

Required?

Cardinality

Content

Values

Description

filters

Y

1

Map<String, String[]>

Y

1

Map Object


The content of search criteria filters; valid columns: REQUEST_ID, SERVICE_INSTANCE_ID, SERVICE_INSTANCE_NAME, STATUS)

startTimeN1long
start time; search range
endTimeN1long
end time; search range
maxResultN1integer
maximum result rows

Response Body

Attribute

Required?

Cardinality

Content

Values

Description

Response

Y

1..N

javax.ws.rs.core.Response =

List<SoInfraRequest>


A response represent a list of SoInfraRequest

...

Attribute

Required?

Cardinality

Content

Values

Description

reqeustId

Y

1

String


A request id, it is used to query the corresponding top-level process Instance Id

serviceInstanceId

Y

1

String


A Service Instance Id

ServiceInstanceName

Y

1

String


A Service Instanced Name

networkIdY1String
A network id
requestStatusY1String
A request Status
serviceTypeY1String
A service type
startTimeY1String
A request start time
endTimeY1String
A request end time


Get

...

Process Instance Id Detail for the given

...

Request Id

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/process-instance-id/{requestId}

Operation Type

Get

Content-Type

application/json

...

Attribute

Required?

Cardinality

Content

Values

Description

Response

Y

1..N

javax.ws.rs.core.Response =

List<ProcessInsanceIdDetail>


A response represent a list of ProcessInstanceIdDetail

...

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/process-instance-id/{processInstanceId}

Operation Type

Get

Content-Type

application/json

...

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/process-definition/{processDefinitionId}

Operation Type

Get

Content-Type

application/json

...

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/activity-instance/{processInstanceId}

Operation Type

Get

Content-Type

application/json

...

Attribute

Required?

Cardinality

Content

Values

Description

Response

Y

1..N

javax.ws.rs.core.Response =

List<ActivityInstanceDetail>


A response represent of a list of ActivityInstanceDetail

...

Interface Definition

Description

URI

httpshttp(s)://{host}:{port}/engine-rest/engine/variable-instance/{processInstanceId}

Operation Type

Get

Content-Type

application/json

...

Attribute

Required?

Cardinality

Content

Values

Description

Response

Y

1..N

javax.ws.rs.core.Response =

List<ProcessInstanceVariableDetail>


A response represent of a list of ProcessInstanceVariableDetail

...