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:

collections

Create a collection
This operation creates a collection resource.

POST   /collections

			https://api.ibm.com/industryresearch/run/v1/collections
		
Keys
Request code
Request model

edge

OBJECT , optional

Access info for the edge data

option

STRING , required

File reference option

ref

OBJECT , optional

URL GET access info in a request

mime

STRING , optional

MIME type

url

STRING , required

GET URL

s3

OBJECT , optional

S3 API read access info in a request body

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

credentials

OBJECT , optional

Credentials of an S3 API access key in a request body

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)

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

name

STRING , required

Object name

prefix

STRING , optional

Object prefix

lifespan

STRING , optional

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

name

STRING , optional

Display name

node

OBJECT , optional

Access info for the node data

option

STRING , required

File reference option

ref

OBJECT , optional

URL GET access info in a request

mime

STRING , optional

MIME type

url

STRING , required

GET URL

s3

OBJECT , optional

S3 API read access info in a request body

bucket

STRING , required

Bucket name

key

OBJECT , required

S3 API access key credentials

credentials

OBJECT , optional

Credentials of an S3 API access key in a request body

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)

option

STRING , required

Key specification option

s3key

STRING , optional

Id of an s3key resource

name

STRING , required

Object name

prefix

STRING , optional

Object prefix

type

STRING , required

Data type [Default: "/fss/aml/mule"]

Request example
{
  "edge": {
    "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,
  "name": string,
  "node": {
    "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
  }
  },
  "type": string
}
Response model

201

Created

Body

collection [CollectionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

[Always] Job properties in a response body

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

Processing result in a response body

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

edge

OBJECT , optional

[Always] Access info for the edge data

lifespan

STRING , optional

Result lifespan

node

OBJECT , optional

[Always] Access info for the node data

type

STRING , optional

[Always] Data type

option

STRING , optional

[Always] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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

Result data option

ref [ResultRefResponse]

OBJECT , optional

URL GET access info for the processing result in a response body

s3 [ResultS3Response]

OBJECT , optional

S3 object access info for the processing result in a response body

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

								{
  "collection" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "edge" : {
    "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,
    "node" : {
    "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
  }
  },
    "type" : 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 collection
This operation deletes a collection resource by id.

DELETE   /collections/{id}

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

id

URL , required

Unique id

Request code
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 collection
This operation retrieves a collection resource by id.

GET   /collections/{id}

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

done

BOOLEAN , optional

Job completion status

id

URL , required

Unique id

Request code
Response model

200

OK

Body

collection [CollectionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

[Always] Job properties in a response body

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

Processing result in a response body

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

edge

OBJECT , optional

[Always] Access info for the edge data

lifespan

STRING , optional

Result lifespan

node

OBJECT , optional

[Always] Access info for the node data

type

STRING , optional

[Always] Data type

option

STRING , optional

[Always] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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

Result data option

ref [ResultRefResponse]

OBJECT , optional

URL GET access info for the processing result in a response body

s3 [ResultS3Response]

OBJECT , optional

S3 object access info for the processing result in a response body

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

								{
  "collection" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "edge" : {
    "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,
    "node" : {
    "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
  }
  },
    "type" : 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 collections
This operation retrieves a list of collections

GET   /collections

			https://api.ibm.com/industryresearch/run/v1/collections
		
Keys
Path and Query parameters

done

BOOLEAN , optional

Job completion status

name

STRING , optional

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

requester

STRING , optional

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

Request code
Response model

200

OK

Body

collection [CollectionInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique ID

job [JobResponse]

OBJECT , optional

[Always] Job properties in a response body

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

Processing result in a response body

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

edge

OBJECT , optional

[Always] Access info for the edge data

lifespan

STRING , optional

Result lifespan

node

OBJECT , optional

[Always] Access info for the node data

type

STRING , optional

[Always] Data type

option

STRING , optional

[Always] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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] File reference option

ref [UrlGetRefResponse]

OBJECT , optional

URL GET access info in a response

s3 [S3ReadResponse]

OBJECT , optional

S3 API read access info in a response body

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

Credentials of an S3 API access key in a response body

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

Result data option

ref [ResultRefResponse]

OBJECT , optional

URL GET access info for the processing result in a response body

s3 [ResultS3Response]

OBJECT , optional

S3 object access info for the processing result in a response body

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

								{
  "collection" : [{
    "id" : string,
    "job" : {
    "creation" : string,
    "deleted" : boolean,
    "done" : boolean,
    "id" : string,
    "message" : string,
    "status" : string,
    "termination" : string
  },
    "name" : string,
    "region" : string,
    "request" : {
    "edge" : {
    "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,
    "node" : {
    "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
  }
  },
    "type" : 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
}
							

Loading content...