Streaming Analytics v2

Live

Streaming Analytics v2

+ Day(s) remaining in the trial

Overview

The Streaming Analytics API allows applications to programmatically use IBM Streams in the cloud, providing the ability to start, stop and size Streaming Analytics instances, submit Streams jobs, compile Streams applications, etc. in a manner that is cloud friendly and scalable. The Streaming Analytics v2 API is only supported on service instances created with one of the new container-based service plans. The v1 API is only supported on existing Streaming Analytics instances and any new instances you create with v1 service plans. All Streaming Analytics instances are highly available.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Streaming Analytics v2:

Instance properties

Operations on Streaming Analytics instance properties.
Delete a Streaming Analytics instance property.
Deletes the value of a property of the Streaming Analytics instance, resetting the property to its default value.

DELETE   /streaming_analytics/{instance_id}/properties/{property_id}

			https://streams-app-service-test.stage1.mybluemix.net/v2/streaming_analytics/{instance_id}/properties/{property_id}
		
Keys
Header parameters

Authorization

STRING , required

Identity Access Management (IAM) bearer token.

Path and Query parameters

instance_id

URL , required

GUID of the Streaming Analytics instance to perform the operation.

property_id

URL , required

ID of the Streaming Analytics instance property to perform the operation.

Request code
								
var http = require("https"); var options = { "method": "DELETE", "hostname": "{rest_url}", "port": null, "path": "/v2/streaming_analytics/{instance_id}/properties/{property_id}", "headers": { "authorization": "Bearer <token>" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
Response model

200

OK

Body

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

202

Accepted

Body

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

400

Bad Request

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

401

Unauthorized

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

403

Forbidden

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

404

Not Found

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

409

Unavailable

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

410

Gone

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

500

Error

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

Response example

200

OK

								{
  "assignable" : true,
  "default" : "error",
  "enum" : ["debug"],
  "id" : "hc.pecTraceLevel",
  "maximum" : 100,
  "minimum" : 0,
  "pending_value" : "debug",
  "requires_restart" : false,
  "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
  "value" : "info"
}
							

202

Accepted

								{
  "assignable" : true,
  "default" : "error",
  "enum" : ["debug"],
  "id" : "hc.pecTraceLevel",
  "maximum" : 100,
  "minimum" : 0,
  "pending_value" : "debug",
  "requires_restart" : false,
  "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
  "value" : "info"
}
							

400

Bad Request

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

401

Unauthorized

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

403

Forbidden

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

404

Not Found

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

409

Unavailable

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

410

Gone

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

500

Error

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							
Get a Streams instance property.
Retrieves information about a property of the Streaming Analytics instance.

GET   /streaming_analytics/{instance_id}/properties/{property_id}

			https://streams-app-service-test.stage1.mybluemix.net/v2/streaming_analytics/{instance_id}/properties/{property_id}
		
Keys
Header parameters

Authorization

STRING , required

Identity Access Management (IAM) bearer token.

Path and Query parameters

instance_id

URL , required

GUID of the Streaming Analytics instance to perform the operation.

property_id

URL , required

ID of the property of the Streaming Analytics instance.

Request code
								
var http = require("https"); var options = { "method": "GET", "hostname": "{rest_url}", "port": null, "path": "/v2/streaming_analytics/{instance_id}/properties/{property_id}", "headers": { "authorization": "Bearer <token>" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
Response model

200

OK

Body

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

400

Bad Request

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

401

Unauthorized

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

403

Forbidden

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

404

Not Found

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

409

Unavailable

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

410

Gone

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

500

Error

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

Response example

200

OK

								{
  "assignable" : true,
  "default" : "error",
  "enum" : ["debug"],
  "id" : "hc.pecTraceLevel",
  "maximum" : 100,
  "minimum" : 0,
  "pending_value" : "debug",
  "requires_restart" : false,
  "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
  "value" : "info"
}
							

400

Bad Request

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

401

Unauthorized

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

403

Forbidden

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

404

Not Found

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

409

Unavailable

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

410

Gone

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

500

Error

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							
Get Streams instance properties.
Retrieves information about properties of the Streaming Analytics instance.

GET   /streaming_analytics/{instance_id}/properties

			https://streams-app-service-test.stage1.mybluemix.net/v2/streaming_analytics/{instance_id}/properties
		
Keys
Header parameters

Authorization

STRING , required

Identity Access Management (IAM) bearer token.

Path and Query parameters

instance_id

URL , required

GUID of the Streaming Analytics instance to perform the operation.

Request code
								
var http = require("https"); var options = { "method": "GET", "hostname": "{rest_url}", "port": null, "path": "/v2/streaming_analytics/{instance_id}/properties", "headers": { "authorization": "Bearer <token>" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
Response model

200

OK

Body

count

INTEGER , required

Number of properties for the the Streaming Analytics instance.

resources [StreamingAnalyticsInstanceProperty]

ARRAY , required

Information about each instance property.

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

400

Bad Request

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

401

Unauthorized

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

403

Forbidden

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

404

Not Found

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

409

Unavailable

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

410

Gone

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

500

Error

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

Response example

200

OK

								{
  "count" : 1,
  "resources" : [{
    "assignable" : true,
    "default" : "error",
    "enum" : ["debug"],
    "id" : "hc.pecTraceLevel",
    "maximum" : 100,
    "minimum" : 0,
    "pending_value" : "debug",
    "requires_restart" : false,
    "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
    "value" : "info"
  }]
}
							

400

Bad Request

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

401

Unauthorized

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

403

Forbidden

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

404

Not Found

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

409

Unavailable

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

410

Gone

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

500

Error

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							
Update a Streaming Analytics instance property.
Changes the value of a property of the Streaming Analytics instance.

PATCH   /streaming_analytics/{instance_id}/properties/{property_id}

			https://streams-app-service-test.stage1.mybluemix.net/v2/streaming_analytics/{instance_id}/properties/{property_id}
		
Keys
Header parameters

Authorization

STRING , required

Identity Access Management (IAM) bearer token.

Path and Query parameters

instance_id

URL , required

GUID of the Streaming Analytics instance to perform the operation.

property_id

URL , required

ID of the property to perform the operation.

value

STRING , required

Specifies the new value for the instace property.

Request code
								
var http = require("https"); var options = { "method": "PATCH", "hostname": "{rest_url}", "port": null, "path": "/v2/streaming_analytics/{instance_id}/properties/{property_id}?value=string", "headers": { "authorization": "Bearer <token>" } }; var req = http.request(options, function (res) { var chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { var body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
Response model

200

OK

Body

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

202

Accepted

Body

assignable

BOOLEAN , required

Indicates whether you can change the value of the instance property.

default

STRING , required

The dafault value for the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

enum

ARRAY , optional

An enumerated list of allowed values for the property. Use this optional value is only for properties with a restricted list of allowed values.

id

STRING , required

The identifier of the instance property.

maximum

INTEGER , optional

The maximum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

minimum

INTEGER , optional

The minimum value allowed for the property. Use this optional value is only for integer properties with a restricted range.

pending_value

STRING , optional

The pending value for this property that will take effect when the instance is restarted. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

requires_restart

BOOLEAN , required

Indicates whether you must restart the instance for a change to take effect.

self

STRING , required

URL pointing to this instance property.

value

STRING , required

The current value of the instance property. The data type can be "STRING", "INTEGER", or "BOOLEAN" depending on the data type of the property.

400

Bad Request

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

401

Unauthorized

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

403

Forbidden

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

404

Not Found

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

409

Unavailable

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

410

Gone

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

500

Error

Body

errors [ErrorModel]

ARRAY , required

trace

STRING , required

code

STRING , required

message

STRING , required

more_info

STRING , optional

target [ErrorTargetModel]

OBJECT , optional

name

STRING , required

type

STRING , required

Response example

200

OK

								{
  "assignable" : true,
  "default" : "error",
  "enum" : ["debug"],
  "id" : "hc.pecTraceLevel",
  "maximum" : 100,
  "minimum" : 0,
  "pending_value" : "debug",
  "requires_restart" : false,
  "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
  "value" : "info"
}
							

202

Accepted

								{
  "assignable" : true,
  "default" : "error",
  "enum" : ["debug"],
  "id" : "hc.pecTraceLevel",
  "maximum" : 100,
  "minimum" : 0,
  "pending_value" : "debug",
  "requires_restart" : false,
  "self" : "https://host.domain:port/v2/streaming_analytics/a0629351-bcae-42ea-b76a-71505559cda1/properties/hc.pecTraceLevel",
  "value" : "info"
}
							

400

Bad Request

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

401

Unauthorized

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

403

Forbidden

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

404

Not Found

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

409

Unavailable

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

410

Gone

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

500

Error

								{
  "errors" : [{
    "code" : "unauthorized",
    "message" : "CDISB4010E Requested file or operation is not accessible with current authorization.",
    "more_info" : string,
    "target" : {
    "name" : string,
    "type" : [field, parameter, header]
  }
  }],
  "trace" : "586556bd-e62e-4a84-957a-e4e087dadd43"
}
							

Loading content...