I2R Financial Services

Live

I2R Financial Services

+ Day(s) remaining in the trial

Overview

The RESTful Financial Services (FSS) of the IBM Industry Research (I2R) comprise of a set of managed API service offerings that deliver a suite of multicloud based financial data processing and/or analytics capabilities. This Swagger specification includes a brief description for each of the PS API operations.

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

I2R Financial Services:

fss-forecast

Create a forecast model
This operation creates a forecast model.

POST   /fss/forecast/models

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/models
		
Keys
Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/industryresearch/run/v1/fss/forecast/models") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .body("{\"metadata\":{\"description\":\"Model metadata\\n\",\"properties\":{\"option\":{\"description\":\"Metadata access option\\n\",\"type\":\"string\"},\"ref\":{\"description\":\"URL GET access info in a request\\n\",\"properties\":{\"mime\":{\"description\":\"MIME type\\n\",\"type\":\"string\"},\"url\":{\"description\":\"GET URL\\n\",\"type\":\"string\"}},\"required\":[\"url\"],\"type\":\"object\"},\"s3\":{\"description\":\"S3 API read access info in a request body\\n\",\"properties\":{\"bucket\":{\"description\":\"Bucket name\\n\",\"type\":\"string\"},\"key\":{\"description\":\"S3 API access key credentials\\n\",\"properties\":{\"credentials\":{\"description\":\"Credentials of an S3 API access key in a request body\\n\",\"properties\":{\"endpoint\":{\"description\":\"S3 API endpoint\\n\",\"type\":\"string\"},\"id\":{\"description\":\"Access key id\\n\",\"type\":\"string\"},\"secret\":{\"description\":\"Access key secret (shown when user id in use is requester)\\n\",\"type\":\"string\"}},\"required\":[\"id\",\"secret\"],\"type\":\"object\"},\"option\":{\"description\":\"Key specification option\\n\",\"type\":\"string\"},\"s3key\":{\"description\":\"Id of an s3key resource\\n\",\"type\":\"string\"}},\"required\":[\"option\"],\"type\":\"object\"},\"name\":{\"description\":\"Object name\\n\",\"type\":\"string\"},\"prefix\":{\"description\":\"Object prefix\\n\",\"type\":\"string\"}},\"required\":[\"key\",\"bucket\",\"name\"],\"type\":\"object\"}},\"required\":[\"option\"],\"type\":\"object\"},\"name\":\"string\"}") .asString();
Request model

metadata

OBJECT , required

Model metadata

name

STRING , optional

Display name

option

STRING , required

Metadata access option

ref

OBJECT , optional

s3

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , required

GET URL

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

name

STRING , required

Object name

prefix

STRING , optional

Object prefix

credentials

OBJECT , optional

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

S3 API endpoint

id

STRING , required

Access key id

secret

STRING , required

Access key secret (shown when user id in use is requester)

Request example
{
  "metadata": {
    "option": string,
    "ref": {
    "mime": string,
    "url": string
  },
    "s3": {
    "bucket": string,
    "key": {
    "credentials": {
    "endpoint": string,
    "id": string,
    "secret": string
  },
    "option": string,
    "s3key": string
  },
    "name": string,
    "prefix": string
  }
  },
  "name": string
}
Response model

201

Created

Body

fss-forecast-model [FssForecastModelInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

metadata

OBJECT , optional

[Always] Model metadata

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

requester

STRING , optional

[Always] Requester id

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

option

STRING , optional

[Always] Metadata access option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

201

Created

								{
  "fss-forecast-model" : [{
    "id" : string,
    "metadata" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "name" : string,
    "region" : string,
    "requester" : string,
    "subscription" : string,
    "timestamp" : string
  }]
}
							

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Create a forecast prediction
This operation creates a forecast prediction.

POST   /fss/forecast/predictions

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions
		
Keys
Request code
								
HttpResponse<String> response = Unirest.post("https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .body("{\"input\":{\"description\":\"Input data\\n\",\"properties\":{\"option\":{\"description\":\"Input data option\\n\",\"type\":\"string\"},\"ref\":{\"description\":\"URL GET access info in a request\\n\",\"properties\":{\"mime\":{\"description\":\"MIME type\\n\",\"type\":\"string\"},\"url\":{\"description\":\"GET URL\\n\",\"type\":\"string\"}},\"required\":[\"url\"],\"type\":\"object\"},\"s3\":{\"description\":\"S3 API read access info in a request body\\n\",\"properties\":{\"bucket\":{\"description\":\"Bucket name\\n\",\"type\":\"string\"},\"key\":{\"description\":\"S3 API access key credentials\\n\",\"properties\":{\"credentials\":{\"description\":\"Credentials of an S3 API access key in a request body\\n\",\"properties\":{\"endpoint\":{\"description\":\"S3 API endpoint\\n\",\"type\":\"string\"},\"id\":{\"description\":\"Access key id\\n\",\"type\":\"string\"},\"secret\":{\"description\":\"Access key secret (shown when user id in use is requester)\\n\",\"type\":\"string\"}},\"required\":[\"id\",\"secret\"],\"type\":\"object\"},\"option\":{\"description\":\"Key specification option\\n\",\"type\":\"string\"},\"s3key\":{\"description\":\"Id of an s3key resource\\n\",\"type\":\"string\"}},\"required\":[\"option\"],\"type\":\"object\"},\"name\":{\"description\":\"Object name\\n\",\"type\":\"string\"},\"prefix\":{\"description\":\"Object prefix\\n\",\"type\":\"string\"}},\"required\":[\"key\",\"bucket\",\"name\"],\"type\":\"object\"}},\"required\":[\"option\"],\"type\":\"object\"},\"lifespan\":\"string\",\"model\":\"string\",\"name\":\"string\",\"result\":{\"description\":\"Out-of-band result delivery preferences\\n\",\"properties\":{\"mime\":{\"description\":\"MIME type\\n\",\"type\":\"string\"},\"s3\":{\"description\":\"S3 API write access info in a request body\\n\",\"properties\":{\"bucket\":{\"description\":\"Bucket name\\n\",\"type\":\"string\"},\"key\":{\"description\":\"S3 API access key credentials\\n\",\"properties\":{\"credentials\":\"~input~properties~s3~properties~key~properties~credentials\",\"option\":{\"description\":\"Key specification option\\n\",\"type\":\"string\"},\"s3key\":{\"description\":\"Id of an s3key resource\\n\",\"type\":\"string\"}},\"required\":[\"option\"],\"type\":\"object\"},\"prefix\":{\"description\":\"Object prefix\\n\",\"type\":\"string\"}},\"required\":[\"key\",\"bucket\"],\"type\":\"object\"}},\"type\":\"object\"}}") .asString();
Request model

input

OBJECT , required

Input data

lifespan

STRING , optional

Result lifespan (sec) [Default: "259200"]

model

STRING , required

Model id

name

STRING , optional

Display name

result

OBJECT , optional

Out-of-band result delivery preferences

option

STRING , required

Input data option

ref

OBJECT , optional

s3

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , required

GET URL

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

name

STRING , required

Object name

prefix

STRING , optional

Object prefix

credentials

OBJECT , optional

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

S3 API endpoint

id

STRING , required

Access key id

secret

STRING , required

Access key secret (shown when user id in use is requester)

mime

STRING , optional

MIME type

s3

OBJECT , optional

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

prefix

STRING , optional

Object prefix

credentials

OBJECT , optional

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

S3 API endpoint

id

STRING , required

Access key id

secret

STRING , required

Access key secret (shown when user id in use is requester)

Request example
{
  "input": {
    "option": string,
    "ref": {
    "mime": string,
    "url": string
  },
    "s3": {
    "bucket": string,
    "key": {
    "credentials": {
    "endpoint": string,
    "id": string,
    "secret": string
  },
    "option": string,
    "s3key": string
  },
    "name": string,
    "prefix": string
  }
  },
  "lifespan": string,
  "model": string,
  "name": string,
  "result": {
    "mime": string,
    "s3": {
    "bucket": string,
    "key": {
    "credentials": {
    "endpoint": string,
    "id": string,
    "secret": string
  },
    "option": string,
    "s3key": string
  },
    "prefix": string
  }
  }
}
Response model

201

Created

Body

fss-forecast-prediction [FssForecastPredictionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

request

OBJECT , optional

[Always] Properties of the request

requester

STRING , optional

[Always] IBMid or w3id of the requester

result [ResultResponse]

OBJECT , optional

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

creation

STRING , optional

[Always] Job creation timestamp in ISO UTC format

deleted

BOOLEAN , optional

[Always] Job deletion status

done

BOOLEAN , optional

[Always] Job completion status

id

STRING , optional

[Always] Job id

message

STRING , optional

[Always] HTTP job status message with optional details

status

STRING , optional

[Always] HTTP status code

termination

STRING , optional

Job termination timestamp in ISO UTC format

input

OBJECT , optional

[Always] Input data

lifespan

STRING , optional

Result lifespan

model

STRING , optional

[Always] Id of the forecast model in use

result

OBJECT , optional

Out-of-band result delivery preferences

option

STRING , optional

[Always] Input data option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

mime

STRING , optional

MIME type

s3 [S3WriteResponse]

OBJECT , optional

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

option

STRING , optional

[Always] Result data option

ref [ResultRefResponse]

OBJECT , optional

s3 [ResultS3Response]

OBJECT , optional

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

name

STRING , optional

[Always] Download file name

size

STRING , optional

[Always] Object size (byte)

url

STRING , optional

[Always] GET URL

bucket_name

STRING , optional

[Always] S3 bucket name

endpoint

STRING , optional

[Always] S3 API endpoint

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

object_key

STRING , optional

[Always] S3 object key

size

STRING , optional

[Always] Object size (byte)

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

201

Created

								{
  "fss-forecast-prediction" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "input" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "lifespan" : string,
    "model" : string,
    "result" : {
    "mime" : string,
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "prefix" : string
  }
  }
  },
    "requester" : string,
    "result" : {
    "option" : string,
    "ref" : {
    "expiration" : string,
    "mime" : string,
    "name" : string,
    "size" : string,
    "url" : string
  },
    "s3" : {
    "bucket_name" : string,
    "endpoint" : string,
    "expiration" : string,
    "mime" : string,
    "object_key" : string,
    "size" : string
  }
  },
    "subscription" : string,
    "timestamp" : string
  }]
}
							

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Delete a forecast model
This operation deletes a forecast model by id.

DELETE   /fss/forecast/models/{id}

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}
		
Keys
Path and Query parameters

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Delete a forecast prediction
This operation deletes a forecast prediction by id.

DELETE   /fss/forecast/predictions/{id}

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions/{id}
		
Keys
Path and Query parameters

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.delete("https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions/{id}") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Do nothing for FSS forecast service
This operation does nothing. It can be used for checking API invocation credentials, performance analysis, API availability monitoring, etc.

GET   /fss/forecast/noop

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/noop
		
Keys
Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/industryresearch/run/v1/fss/forecast/noop") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Retrieve a forecast model
This operation retrieves a forecast model by id.

GET   /fss/forecast/models/{id}

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}
		
Keys
Path and Query parameters

done

BOOLEAN , optional

Job completion status

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}?done=true") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

200

OK

Body

fss-forecast-model [FssForecastModelInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

metadata

OBJECT , optional

[Always] Model metadata

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

requester

STRING , optional

[Always] Requester id

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

option

STRING , optional

[Always] Metadata access option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "fss-forecast-model" : [{
    "id" : string,
    "metadata" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "name" : string,
    "region" : string,
    "requester" : string,
    "subscription" : string,
    "timestamp" : string
  }]
}
							

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Retrieve a forecast prediction
This operation retrieves a forecast prediction by id.

GET   /fss/forecast/predictions/{id}

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions/{id}
		
Keys
Path and Query parameters

done

BOOLEAN , optional

Job completion status

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions/{id}?done=true") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

200

OK

Body

fss-forecast-prediction [FssForecastPredictionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

request

OBJECT , optional

[Always] Properties of the request

requester

STRING , optional

[Always] IBMid or w3id of the requester

result [ResultResponse]

OBJECT , optional

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

creation

STRING , optional

[Always] Job creation timestamp in ISO UTC format

deleted

BOOLEAN , optional

[Always] Job deletion status

done

BOOLEAN , optional

[Always] Job completion status

id

STRING , optional

[Always] Job id

message

STRING , optional

[Always] HTTP job status message with optional details

status

STRING , optional

[Always] HTTP status code

termination

STRING , optional

Job termination timestamp in ISO UTC format

input

OBJECT , optional

[Always] Input data

lifespan

STRING , optional

Result lifespan

model

STRING , optional

[Always] Id of the forecast model in use

result

OBJECT , optional

Out-of-band result delivery preferences

option

STRING , optional

[Always] Input data option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

mime

STRING , optional

MIME type

s3 [S3WriteResponse]

OBJECT , optional

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

option

STRING , optional

[Always] Result data option

ref [ResultRefResponse]

OBJECT , optional

s3 [ResultS3Response]

OBJECT , optional

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

name

STRING , optional

[Always] Download file name

size

STRING , optional

[Always] Object size (byte)

url

STRING , optional

[Always] GET URL

bucket_name

STRING , optional

[Always] S3 bucket name

endpoint

STRING , optional

[Always] S3 API endpoint

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

object_key

STRING , optional

[Always] S3 object key

size

STRING , optional

[Always] Object size (byte)

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "fss-forecast-prediction" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "input" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "lifespan" : string,
    "model" : string,
    "result" : {
    "mime" : string,
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "prefix" : string
  }
  }
  },
    "requester" : string,
    "result" : {
    "option" : string,
    "ref" : {
    "expiration" : string,
    "mime" : string,
    "name" : string,
    "size" : string,
    "url" : string
  },
    "s3" : {
    "bucket_name" : string,
    "endpoint" : string,
    "expiration" : string,
    "mime" : string,
    "object_key" : string,
    "size" : string
  }
  },
    "subscription" : string,
    "timestamp" : string
  }]
}
							

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Retrieve a list of forecast models
This operation retrieves a list of forecast models.

GET   /fss/forecast/models

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/models
		
Keys
Path and Query parameters

done

BOOLEAN , optional

Job completion status

name

STRING , optional

Conditionally retrieve a list of forecast models by a case-insensitive name-matching string

requester

STRING , optional

Conditionally retrieve a list of forecast models by a case-insensitive requester-matching string

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/industryresearch/run/v1/fss/forecast/models?name=string&requester=string&done=true") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

200

OK

Body

fss-forecast-model [FssForecastModelInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

metadata

OBJECT , optional

[Always] Model metadata

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

requester

STRING , optional

[Always] Requester id

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

option

STRING , optional

[Always] Metadata access option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "fss-forecast-model" : [{
    "id" : string,
    "metadata" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "name" : string,
    "region" : string,
    "requester" : string,
    "subscription" : string,
    "timestamp" : string
  }]
}
							

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Retrieve a list of forecast predictions
This operation retrieves a list of forecast predictions.

GET   /fss/forecast/predictions

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions
		
Keys
Path and Query parameters

done

BOOLEAN , optional

Job completion status

name

STRING , optional

Conditionally retrieve a list of forecast predictions by a case-insensitive name-matching string

requester

STRING , optional

Conditionally retrieve a list of forecast predictions by a case-insensitive requester-matching string

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/industryresearch/run/v1/fss/forecast/predictions?name=string&requester=string&done=true") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .asString();
Response model

200

OK

Body

fss-forecast-prediction [FssForecastPredictionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

request

OBJECT , optional

[Always] Properties of the request

requester

STRING , optional

[Always] IBMid or w3id of the requester

result [ResultResponse]

OBJECT , optional

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

creation

STRING , optional

[Always] Job creation timestamp in ISO UTC format

deleted

BOOLEAN , optional

[Always] Job deletion status

done

BOOLEAN , optional

[Always] Job completion status

id

STRING , optional

[Always] Job id

message

STRING , optional

[Always] HTTP job status message with optional details

status

STRING , optional

[Always] HTTP status code

termination

STRING , optional

Job termination timestamp in ISO UTC format

input

OBJECT , optional

[Always] Input data

lifespan

STRING , optional

Result lifespan

model

STRING , optional

[Always] Id of the forecast model in use

result

OBJECT , optional

Out-of-band result delivery preferences

option

STRING , optional

[Always] Input data option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

mime

STRING , optional

MIME type

s3 [S3WriteResponse]

OBJECT , optional

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

option

STRING , optional

[Always] Result data option

ref [ResultRefResponse]

OBJECT , optional

s3 [ResultS3Response]

OBJECT , optional

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

name

STRING , optional

[Always] Download file name

size

STRING , optional

[Always] Object size (byte)

url

STRING , optional

[Always] GET URL

bucket_name

STRING , optional

[Always] S3 bucket name

endpoint

STRING , optional

[Always] S3 API endpoint

expiration

STRING , optional

[Always] Expiration timestamp in ISO UTC format

mime

STRING , optional

[Always] MIME type

object_key

STRING , optional

[Always] S3 object key

size

STRING , optional

[Always] Object size (byte)

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "fss-forecast-prediction" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "input" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "lifespan" : string,
    "model" : string,
    "result" : {
    "mime" : string,
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "prefix" : string
  }
  }
  },
    "requester" : string,
    "result" : {
    "option" : string,
    "ref" : {
    "expiration" : string,
    "mime" : string,
    "name" : string,
    "size" : string,
    "url" : string
  },
    "s3" : {
    "bucket_name" : string,
    "endpoint" : string,
    "expiration" : string,
    "mime" : string,
    "object_key" : string,
    "size" : string
  }
  },
    "subscription" : string,
    "timestamp" : string
  }]
}
							

204

No Content

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Update a model resource
This operation updates an model resource by id per the subscription in use.

PUT   /fss/forecast/models/{id}

			https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}
		
Keys
Path and Query parameters

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.put("https://api.ibm.com/industryresearch/run/v1/fss/forecast/models/{id}") .header("authorization", "Basic REPLACE_BASIC_AUTH") .header("x-ibm-client-id", "REPLACE_KEY_VALUE") .header("x-ibm-client-secret", "REPLACE_KEY_VALUE") .body("{\"metadata\":{\"description\":\"Model metadata\\n\",\"properties\":{\"option\":{\"description\":\"Metadata access option\\n\",\"type\":\"string\"},\"ref\":{\"description\":\"URL GET access info in a request\\n\",\"properties\":{\"mime\":{\"description\":\"MIME type\\n\",\"type\":\"string\"},\"url\":{\"description\":\"GET URL\\n\",\"type\":\"string\"}},\"required\":[\"url\"],\"type\":\"object\"},\"s3\":{\"description\":\"S3 API read access info in a request body\\n\",\"properties\":{\"bucket\":{\"description\":\"Bucket name\\n\",\"type\":\"string\"},\"key\":{\"description\":\"S3 API access key credentials\\n\",\"properties\":{\"credentials\":{\"description\":\"Credentials of an S3 API access key in a request body\\n\",\"properties\":{\"endpoint\":{\"description\":\"S3 API endpoint\\n\",\"type\":\"string\"},\"id\":{\"description\":\"Access key id\\n\",\"type\":\"string\"},\"secret\":{\"description\":\"Access key secret (shown when user id in use is requester)\\n\",\"type\":\"string\"}},\"required\":[\"id\",\"secret\"],\"type\":\"object\"},\"option\":{\"description\":\"Key specification option\\n\",\"type\":\"string\"},\"s3key\":{\"description\":\"Id of an s3key resource\\n\",\"type\":\"string\"}},\"required\":[\"option\"],\"type\":\"object\"},\"name\":{\"description\":\"Object name\\n\",\"type\":\"string\"},\"prefix\":{\"description\":\"Object prefix\\n\",\"type\":\"string\"}},\"required\":[\"key\",\"bucket\",\"name\"],\"type\":\"object\"}},\"required\":[\"option\"],\"type\":\"object\"},\"name\":\"string\"}") .asString();
Request model

metadata

OBJECT , required

Model metadata

name

STRING , optional

Display name

option

STRING , required

Metadata access option

ref

OBJECT , optional

s3

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , required

GET URL

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

name

STRING , required

Object name

prefix

STRING , optional

Object prefix

credentials

OBJECT , optional

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

S3 API endpoint

id

STRING , required

Access key id

secret

STRING , required

Access key secret (shown when user id in use is requester)

Request example
{
  "metadata": {
    "option": string,
    "ref": {
    "mime": string,
    "url": string
  },
    "s3": {
    "bucket": string,
    "key": {
    "credentials": {
    "endpoint": string,
    "id": string,
    "secret": string
  },
    "option": string,
    "s3key": string
  },
    "name": string,
    "prefix": string
  }
  },
  "name": string
}
Response model

201

Created

Body

fss-forecast-model [FssForecastModelInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

metadata

OBJECT , optional

[Always] Model metadata

name

STRING , optional

[Always] Display name

region

STRING , optional

[Always] IBM Cloud region

requester

STRING , optional

[Always] Requester id

subscription

STRING , optional

[Always] Subscription id

timestamp

STRING , optional

[Always] Timestamp in ISO format

option

STRING , optional

[Always] Metadata access option

ref [UrlGetRefResponse]

OBJECT , optional

s3 [S3ReadResponse]

OBJECT , optional

mime

STRING , optional

MIME type

url

STRING , optional

[Always] GET URL

bucket

STRING , optional

[Always] Bucket name

key

OBJECT , optional

[Always] S3 API access key credentials

name

STRING , optional

[Always] Object name

prefix

STRING , optional

[Always] Object prefix

credentials [S3keyCredentialsResponse]

OBJECT , optional

option

STRING , optional

[Always] Key specification option

s3key

STRING , optional

Id of an s3key resource

endpoint

STRING , optional

[Always] S3 API endpoint

id

STRING , optional

[Always] Access key id

secret

STRING , optional

Access key secret (shown when user id in use is requester)

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

201

Created

								{
  "fss-forecast-model" : [{
    "id" : string,
    "metadata" : {
    "option" : string,
    "ref" : {
    "mime" : string,
    "url" : string
  },
    "s3" : {
    "bucket" : string,
    "key" : {
    "credentials" : {
    "endpoint" : string,
    "id" : string,
    "secret" : string
  },
    "option" : string,
    "s3key" : string
  },
    "name" : string,
    "prefix" : string
  }
  },
    "name" : string,
    "region" : string,
    "requester" : string,
    "subscription" : string,
    "timestamp" : string
  }]
}
							

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							

Loading content...