Skip to main content

Gets a Data Instance

GET 

/v1/data-instances/:dataInstanceId

Gets a Data Instance

Request

Path Parameters

    dataInstanceId stringrequired

    The Data Instance identifier.

Query Parameters

    formatted boolean

    Return the Data Instance with formatted values.

Responses

OK

Schema

    instance

    object

    required

    The details of a Data Instance.

    id stringrequired

    The identifier of the Data Instance.

    auctionDate date-timerequired

    The date time on which the Data Instance was auctioned.

    roles DataInstanceRole (string)[]required

    The roles played in the Data Instance.

    Possible values: [SELLER, BUYER]

    winner boolean

    (Optional) Whether the caller of the Data Instance is the winner.

    campaignId string

    (Optional) The identifier of the Campaign that won the Data Instance.

    bid

    object

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    paid

    object

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    units int64required

    The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

    nanos int32required

    Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

    properties

    object[]

    required

    The properties of the Data Instance.

  • Array [

  • label stringrequired

    The label of the detail.

    value required

    The value of the detail.

  • ]

Loading...