Search this site

Workflow Sample

Workflow Sample
Workflow Sample

Contact

System Administration API


General Information

Responses

Responses are the same as the Process Execution API. Please see here for details.

Response Objects

Listed in each process.

List of Operations

Operations that can be handled by the Syste Administration API are listed below.
Replace <ContextRoot> in the URLs with the Questetra BPM Suite context root you are connecting to.
 Operation  URL
Retrieving Cached Choices information  <ContextRoot>/API/Admin/ItemCache/list
Clearing Cached Choices information  <ContextRoot>/API/Admin/ItemCache/delete

Retrieving Cached Choices information

Retrieves a list of choices information that is cached in the Questetra BPM Suite when using [Specify choices via HTTP.] in Select type data item.
System administration Authorization is required to access.

Implemented version

8.4.0

URL

<ContextRoot>/API/Admin/ItemCache/list

Parameters

None

Responses

 Object  Description
 items Map of cached choices information.
Keys are URLs which provide choices information.  Its value is the choices information.

Response Example




{"items":
  {"http:\/\/qbpms-select.appspot.com\/simple\/yesno.xml":
    {"true":
      {"display":"Yes","value":"true"},
     "false":
      {"display":"No","value":"false"}
    }
  }
}

Errors That May Occur

None

Clearing Cached Choices information

Clearing a list of choices information that is cached in the Questetra BPM Suite when using [Specify choices via HTTP.] in Select type data item.
System administration Authorization is required to access.

Implemented version

8.4.0

URL

<ContextRoot>/API/Admin/ItemCache/delete

Parameter

 Parameter name  Description
url URL which provides clear choices information.

Response

There is no response object.  If the operation succeeds, it returns only the HTTP code 200.  It returns HTTP code 200, if specified choices information is not cached.

Errors That May Occur

  • Validation（If not specified parameter）

Errors

 Type  Error code  Description
 Validation  10000  Validation error on particular parameter.