IBM PAIRS Services

Live

IBM PAIRS Services

+ Day(s) remaining in the trial

Overview

IBM PAIRS Services (IPS) is a managed API offering that provides geospatial big data curation, repository, and cognitive physical analytics capabilities via a cloud-centric simple and scalable REST API. PAIRS stands for Physical Analytics Integrated Data Repository and Services. This API offering includes a continuously-updated petabyte repository of curated geo-spatiotemporal data, which lowers big data management and time-to-discovery cost significantly for its customers. It employs cognitive physical modeling and analysis technologies to provision, e.g., high accuracy weather forecasting and agricultural models. Unique industry specific analytics of PAIRS include, among other use cases, global irrigation forecasts, global seasonal weather forecasts, US wide renewable energy generation forecasts, and crop acreage forecasts. Its query performance is scalable in terms of the searched data size. Finally, it supports subscription based self-service management of subscriptions, subscribers, and lifecycle of API keys (including API key creation, sharing, and revocation). This Swagger specification includes a brief description for each IPS API operation. The authoriative document of the API, titled "IBM PAIRS Services: REST API Specification and Developer Guide" is available for download at https://pairs.mybluemix.net/doc/IBM-PAIRS-Services-v1.pdf A pair of demo IBMid and API key ia included in the document to facilitate exploring IPS capabilities. Open source IPS client samples are available from GitHub at https://github.com/webchang/ibm-ips-samples

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

IBM PAIRS Services:

corpuses

Retrieve a corpus resource
This operation retrieves a corpus resource by id.

GET   /corpuses/{id}

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

id

URL , required

Unique id

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/pairs/run/v1/corpuses/{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

200

OK

Body

corpus [CorpusInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique id

policy [CorpusPolicy]

ARRAY , optional

[Always] A list of dataset policies, one per dataset

timestamp

STRING , optional

[Always] Last modification timestamp in ISO UTC format

id

STRING , optional

[Always] Unique dataset id

name

STRING , optional

[Always] Display name

usage

STRING , optional

[Always] Dataset usage policy ("write", "read", "filter", "exclude")

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "corpus" : [object{
    "id" : string,
    "policy" : [object{
    "id" : string,
    "name" : string,
    "usage" : string
  }],
    "timestamp" : string
  }]
}
							

default

Unexpected error

								{
  "httpCode" : string,
  "httpMessage" : string,
  "moreInformation" : string
}
							
Retrieve a list of corpus resources
This operation retrieves a list of corpus resources per the subscription in use. The usage policy for each dataset in a corpus can be "write", "read", "filter", or "exclude".

GET   /corpuses

			https://api.ibm.com/pairs/run/v1/corpuses
		
Keys
Path and Query parameters

id

STRING , optional

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

Request code
								
HttpResponse<String> response = Unirest.get("https://api.ibm.com/pairs/run/v1/corpuses?id=string") .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

corpus [CorpusInfo]

ARRAY , optional

[Always] Response tag

id

STRING , optional

[Always] Unique id

policy [CorpusPolicy]

ARRAY , optional

[Always] A list of dataset policies, one per dataset

timestamp

STRING , optional

[Always] Last modification timestamp in ISO UTC format

id

STRING , optional

[Always] Unique dataset id

name

STRING , optional

[Always] Display name

usage

STRING , optional

[Always] Dataset usage policy ("write", "read", "filter", "exclude")

204

No Content

default

Unexpected error

Body

httpCode

STRING , optional

httpMessage

STRING , optional

moreInformation

STRING , optional

Response example

200

OK

								{
  "corpus" : [object{
    "id" : string,
    "policy" : [object{
    "id" : string,
    "name" : string,
    "usage" : string
  }],
    "timestamp" : string
  }]
}
							

204

No Content

default

Unexpected error

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

Loading content...