Skip to Content

REST v.2 properties

Properties are named variables that can be assigned property values (polymorphic) for themselves (default values), Installed Components, Application Components, Requests, Servers, Server Aspects, and Server Levels.

Warning

Note

A property value is a related model to properties but it should not be updated and manipulated directly. Add or change a property value through the parent property model, because special getters and setters ensure that prior values are time-stamped as deleted_at to maintain a clear audit record of property value changes.

These API commands are is supported only for version 5.0.03 and later.

GET v2/steps/[step_ID]/properties

Returns the properties added for the specified step.

Common attributes

  • format — Ensure to include an accept header or add .json to the last path element
  • token — Your API Token for authentication

Errors caused

  • ERROR 403 Forbidden — When the token is invalid
  • ERROR 404 Not Found — When no records are found

Example

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

curl command input
curl -i -H "accept: application/json" -X GET http://[rails_host]/v2/steps/[step_ID]/properties?token=[api_token]
Sample output
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
X-UA-Compatible: IE=Edge,chrome=1
ETag: "2b4aa405186894cf2a2f1c2121c8a72b"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 620acc5bab78a9430d8ed9347dab3f38
X-Runtime: 0.109000
Date: Fri, 08 Dec 2017 17:43:02 GMT
X-Rack-Cache: miss
Vary: Origin
Referrer-Policy: origin-when-cross-origin
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: DENY
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked

{
  "data": [
      {
        "active": true,
        "created_at": "2017-12-07T14:36:14-06:00",
        "id": 1,
        "is_private": false,
        "name": "Property",
        "updated_at": "2017-12-07T14:36:14-06:00",
        "display_value": "111",
        "updated_value": "111",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-07T14:41:08-06:00",
        "id": 2,
        "is_private": false,
        "name": "property 02",
        "updated_at": "2017-12-07T14:41:08-06:00",
        "display_value": "222",
        "updated_value": "222",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T08:27:28-06:00",
        "id": 5,
        "is_private": true,
        "name": "Property_Value_03",
        "updated_at": "2017-12-08T08:27:28-06:00",
        "display_value": "*****************",
        "updated_value": "*****************",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:15:50-06:00",
        "id": 6,
        "is_private": true,
        "name": "NewProperty 01",
        "updated_at": "2017-12-08T09:15:50-06:00",
        "display_value": "**************",
        "updated_value": "**************",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:04-06:00",
        "id": 7,
        "is_private": false,
        "name": "NewProperty 02",
        "updated_at": "2017-12-08T09:16:04-06:00",
        "display_value": "NewProperty 01",
        "updated_value": "NewProperty 01",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:24-06:00",
        "id": 8,
        "is_private": false,
        "name": "NewProperty 03",
        "updated_at": "2017-12-08T09:16:24-06:00",
        "display_value": "NewProperty 02",
        "updated_value": "NewProperty 02",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:39-06:00",
        "id": 9,
        "is_private": false,
        "name": "NewProperty 04",
        "updated_at": "2017-12-08T09:59:41-06:00",
        "display_value": "1234512345",
        "updated_value": "1234512345",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:52-06:00",
        "id": 10,
        "is_private": false,
        "name": "NewProperty 05",
        "updated_at": "2017-12-08T09:16:52-06:00",
        "display_value": "NewProperty 01",
        "updated_value": "NewProperty 01",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:02-06:00",
        "id": 11,
        "is_private": false,
        "name": "NewProperty 06",
        "updated_at": "2017-12-08T09:17:02-06:00",
        "display_value": "",
        "updated_value": null,
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:31-06:00",
        "id": 13,
        "is_private": false,
        "name": "NewProperty 08",
        "updated_at": "2017-12-08T09:17:31-06:00",
        "display_value": "NewProperty 08",
        "updated_value": "NewProperty 08",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:44-06:00",
        "id": 14,
        "is_private": false,
        "name": "NewProperty 09",
        "updated_at": "2017-12-08T09:17:44-06:00",
        "display_value": "NewProperty 9",
        "updated_value": "NewProperty 9",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:15-06:00",
        "id": 12,
        "is_private": true,
        "name": "NewProperty 07",
        "updated_at": "2017-12-08T09:17:15-06:00",
        "display_value": "**************",
        "updated_value": "**************",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:18:20-06:00",
        "id": 15,
        "is_private": true,
        "name": "NewProperty 10",
        "updated_at": "2017-12-08T09:18:20-06:00",
        "display_value": "**************",
        "updated_value": "**************",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      }
  ],
  "total_records": 13
}

GET v2/components/[component_ID]/properties

Returns the properties for a specified component. These properties are displayed while creating a new step.

Common attributes

  • format — Ensure to include an accept header or add .json to the last path element
  • token — Your API Token for authentication

Errors caused

  • ERROR 403 Forbidden — When the token is invalid
  • ERROR 404 Not Found — When no records are found

Example

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

curl command input
curl -i -H "accept: application/json" -X GET http://[rails_host]/v2/component/[component_ID]/properties?token=[api_token]
Sample output
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
X-UA-Compatible: IE=Edge,chrome=1
ETag: "eea9486d315be2d1fd5470633f61bdb3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 312c6897cacd97d2980f722192270659
X-Runtime: 0.031000
Date: Fri, 08 Dec 2017 20:26:18 GMT
X-Rack-Cache: miss
Vary: Origin
Referrer-Policy: origin-when-cross-origin
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: DENY
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked

{
  "data": [
      {
        "active": true,
        "created_at": "2017-12-07T14:36:14-06:00",
        "id": 1,
        "is_private": false,
        "name": "Property",
        "updated_at": "2017-12-07T14:36:14-06:00",
        "display_value": "111"
      },
      {
        "active": true,
        "created_at": "2017-12-07T14:41:08-06:00",
        "id": 2,
        "is_private": false,
        "name": "property 02",
        "updated_at": "2017-12-07T14:41:08-06:00",
        "display_value": "222"
      },
      {
        "active": true,
        "created_at": "2017-12-08T08:27:28-06:00",
        "id": 5,
        "is_private": true,
        "name": "Property_Value_03",
        "updated_at": "2017-12-08T08:27:28-06:00",
        "display_value": "*****************"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:15:50-06:00",
        "id": 6,
        "is_private": true,
        "name": "NewProperty 01",
        "updated_at": "2017-12-08T09:15:50-06:00",
        "display_value": "**************"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:04-06:00",
        "id": 7,
        "is_private": false,
        "name": "NewProperty 02",
        "updated_at": "2017-12-08T09:16:04-06:00",
        "display_value": "NewProperty 01"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:24-06:00",
        "id": 8,
        "is_private": false,
        "name": "NewProperty 03",
        "updated_at": "2017-12-08T09:16:24-06:00",
        "display_value": "NewProperty 02"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:39-06:00",
        "id": 9,
        "is_private": false,
        "name": "NewProperty 04",
        "updated_at": "2017-12-08T09:59:41-06:00",
        "display_value": "1234512345"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:16:52-06:00",
        "id": 10,
        "is_private": false,
        "name": "NewProperty 05",
        "updated_at": "2017-12-08T09:16:52-06:00",
        "display_value": "NewProperty 01"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:02-06:00",
        "id": 11,
        "is_private": false,
        "name": "NewProperty 06",
        "updated_at": "2017-12-08T09:17:02-06:00",
        "display_value": ""
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:31-06:00",
        "id": 13,
        "is_private": false,
        "name": "NewProperty 08",
        "updated_at": "2017-12-08T09:17:31-06:00",
        "display_value": "NewProperty 08"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:44-06:00",
        "id": 14,
        "is_private": false,
        "name": "NewProperty 09",
        "updated_at": "2017-12-08T09:17:44-06:00",
        "display_value": "NewProperty 9"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:17:15-06:00",
        "id": 12,
        "is_private": true,
        "name": "NewProperty 07",
        "updated_at": "2017-12-08T09:17:15-06:00",
        "display_value": "**************"
      },
      {
        "active": true,
        "created_at": "2017-12-08T09:18:20-06:00",
        "id": 15,
        "is_private": true,
        "name": "NewProperty 10",
        "updated_at": "2017-12-08T09:18:20-06:00",
        "display_value": "**************"
      },
      {
        "active": true,
        "created_at": "2017-12-08T12:01:11-06:00",
        "id": 20,
        "is_private": false,
        "name": "Phase property",
        "updated_at": "2017-12-08T12:01:11-06:00",
        "display_value": "1234"
      }
  ],
  "total_records": 14
}

GET v2/steps/[step_ID]/components/[component_ID]/properties

Retrieves properties for a specified step and a component. 

Common attributes

  • format — Ensure to include an accept header or add .json to the last path element
  • token — Your API Token for authentication

Errors caused

  • ERROR 403 Forbidden — When the token is invalid
  • ERROR 404 Not Found — When no records are found

Example

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

curl command input
curl -i -H "accept: application/json" -X GET http://[rails_host]/v2/steps/[step_ID]/components/[component_ID]/properties?token=[api_token]

GET v2/steps/[step_ID]/components/[component_ID]/work_tasks/[work_task_ID]/properties

Retrieves properties for a specified step, a component, and a work task. 

Common attributes

  • format — Ensure to include an accept header or add .json to the last path element
  • token — Your API Token for authentication

Errors caused

  • ERROR 403 Forbidden — When the token is invalid
  • ERROR 404 Not Found — When no records are found

Example

To test this method, insert this URL or your valid API key and application host into a browser or HTTP client like wget or curl. For example:

curl command input
curl -i -H "accept: application/json" -X GET http://[rails_host]/v2/steps/[step_ID]/components/[component_ID]/work_tasks/[work_task_ID]/properties?token=[api_token]
sample output
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
X-UA-Compatible: IE=Edge,chrome=1
ETag: "bf4c68906099a6f4aed2d181f0663996"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: fea47e0fa1afd3efaa5c0c31545d90ce
X-Runtime: 0.086000
Date: Wed, 20 Dec 2017 16:35:25 GMT
X-Rack-Cache: miss
Vary: Origin
Referrer-Policy: origin-when-cross-origin
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Frame-Options: DENY
X-Permitted-Cross-Domain-Policies: none
X-XSS-Protection: 1; mode=block
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked

{
  "data": [
      {
        "active": true,
        "created_at": "2014-01-28T07:12:07+05:30",
        "id": 10000,
        "is_private": false,
        "name": "include_path_jython",
        "updated_at": "2017-08-28T23:30:56+05:30",
        "display_value": "/nas/bmc/rlm/persist/automation_libs/util_frameworkJythonInclude.py",
        "updated_value": "/nas/bmc/rlm/persist/automation_libs/util_frameworkJythonInclude.py",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2014-01-28T07:12:07+05:30",
        "id": 10001,
        "is_private": false,
        "name": "include_path_ruby",
        "updated_at": "2017-08-28T23:30:56+05:30",
        "display_value": "/nas/bmc/rlm/persist/automation_libs/util_frameworkRubyInclude.rb",
        "updated_value": "/nas/bmc/rlm/persist/automation_libs/util_frameworkRubyInclude.rb",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2014-01-28T07:12:07+05:30",
        "id": 10006,
        "is_private": false,
        "name": "RLM_TECH_STACKS",
        "updated_at": "2017-12-14T03:57:01+05:30",
        "display_value": "YES",
        "updated_value": "YES",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2014-01-28T07:12:07+05:30",
        "id": 10002,
        "is_private": false,
        "name": "RLM_package_name",
        "updated_at": "2014-04-09T01:27:45+05:30",
        "display_value": null,
        "updated_value": null,
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2014-05-28T17:45:03+05:30",
        "id": 10281,
        "is_private": false,
        "name": "Emergency_Deployment",
        "updated_at": "2017-08-28T23:30:56+05:30",
        "display_value": "emer",
        "updated_value": "emer",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2014-11-17T22:41:11+05:30",
        "id": 10641,
        "is_private": false,
        "name": "EMER_RUNTIME_PHASE_ID",
        "updated_at": "2017-08-28T23:30:56+05:30",
        "display_value": "10060",
        "updated_value": "10060",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-08-28T23:30:54+05:30",
        "id": 11841,
        "is_private": null,
        "name": "Prop 1",
        "updated_at": "2017-08-28T23:36:26+05:30",
        "display_value": null,
        "updated_value": "value1-updated",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-08-28T23:30:55+05:30",
        "id": 11842,
        "is_private": null,
        "name": "Prop 2",
        "updated_at": "2017-08-28T23:36:26+05:30",
        "display_value": null,
        "updated_value": "value2-updated",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      },
      {
        "active": true,
        "created_at": "2017-12-15T22:31:59+05:30",
        "id": 11887,
        "is_private": true,
        "name": "p1",
        "updated_at": "2017-12-15T22:31:59+05:30",
        "display_value": "*******************",
        "updated_value": "*******************",
        "locked": false,
        "work_task_allow_update": true,
        "installed_component_id": 1
      }
  ],
  "total_records": 9
}

Related topic

Using-REST-API

REST-API-version-2

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Release Process Management 5.0.06