content

Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

The ContentBroker interface allows to discover and order third party data using Smart M.App Platform.

Methods

Name Summary
discover

Discover datasets

getOrders

Returns list of all current user orders

getOrderStatus

Returns list of all current user orders

listProviders

Returns list codenames of providers available for the current user

placeOrder

Place an order

Methods • Details

discover(filters, callback, errback) → {void}(async, static)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Discover datasets

Parameters

Name Type Description
filters Object
{
 "provider": String,
 "products": Array,
 "minAcquisitionDate": Date,
 "maxAcquisitionDate": Date,
 "bbox": Array,
 "minCloudCover": Number,
 "maxCloudCover": Number,
 "minResolution": Number,
 "maxResolution": Number,
 "identifier": String,
 "sortBy": String
}

A object with filter

provider

Codename of the provider

products

List of products of the selected provider

minAcquisitionDate optional

Minimum acquisition date of the dataset

maxAcquisitionDate optional

Maximum acquisition date of the dataset

bbox optional

BBOX representing area of the search. Must be in CRS:4326. Coordinates should be defined in order: minx, miny, maxx, maxy

minCloudCover optional

Minimum cloud cover of the dataset (percentage value)

maxCloudCover optional

Maximum cloud cover of the dataset (percentage value)

minResolution optional

Minimum resolution of the dataset (in pixels/meter unit)

maxResolution optional

Maximum resolution of the dataset (in pixels/meter unit)

identifier optional

Find particular dataset with provided identifier

sortBy optional

Sort datasets by the selected property

callback optional

Callback executed on a success

errback optional

Callback executed on a failure

Returns

TypeDescription
void

getOrders(callback, errback) → {void}(async, static)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Returns list of all current user orders

Parameters

Name Type Description
callback optional

Callback executed on a success

errback optional

Callback executed on a failure

Returns

TypeDescription
void

getOrderStatus(identifier, profile, callback, errback) → {void}(async, static)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Returns list of all current user orders

Parameters

Name Type Description
identifier String

Identifier of the order

profile String

Profile of the response. Allowed values: "summary", "detailed"

callback optional

Callback executed on a success

errback optional

Callback executed on a failure

Returns

TypeDescription
void

listProviders(callback, errback) → {void}(async, static)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Returns list codenames of providers available for the current user

Parameters

Name Type Description
callback optional

Callback executed on a success

errback optional

Callback executed on a failure

Returns

TypeDescription
void

placeOrder(parameters, callback, errback) → {void}(async, static)

async
Available for:Map PanelBI Map PanelRecipe PanelCustom Panel

Place an order

Parameters

Name Type Description
parameters Object
{
 "provider": String,
 "identifier": String,
 "containerFolder": String,
 "userDescription": String,
 "postprocessing": Array
}

A object with filter

provider

Codename of the provider

identifier

Identifier of the dataset to order

containerFolder optional

Catalog identifier of the folder where order will be stored (ROOT folder if not specified)

userDescription optional

User-friendly name of the order (Dataset identifier if not specified)

postprocessing optional

Identifiers of the post-processing to execute within the order process

callback optional

Callback executed on a success

errback optional

Callback executed on a failure

Returns

TypeDescription
void