Checking Step Action Availability

Description

You can check the availability of a Step Action for a particular object. The availability of Actions depends on object types, object statuses, security roles, and possibly other criteria.

HTTP method

GET

API URL
http://www.example.com/api/v2/object/<oid>/action/<actionId>/check
URL parameters
Parameter Description

oid

The object identifier in Alloy Navigator Express.

For example: T000002

INFO: For more information, see Identification of Objects in Alloy Navigator Express.

NOTE: This HTTP request cannot be used to check Step Action availability for objects that belong in the Software Catalog and Stock Room sections of the product.

actionId

The ID of a Step Action.

Example: 253

Example 1

In this example Step Action 253 for object T000002 is available.

Request:

(GET) http://www.example.com/api/v2/

 

bject/T000002/action/253/check

Response:

{

	"success": true,

	"errorCode": 0,

	"errorText": "",

	"responseObject": {

		"Result": true

	}

}
Example 2

In this example Step Action #247 for object T000002 is unavailable.

Request:

(GET) http://www.example.com/api/v2/object/T000002/action/247/check

Response:

{

	"success": true,

	"errorCode": 0,

	"errorText": "",

	"responseObject": {

		"Result": false

	}

}