Data Fabric IoT Time Series Query API

API change history

Query API for time series data

/api/v2/StoredProcedure/{procedureName}/.execute - POST

Try it

Request

Request URL

Request parameters

  • string

Request headers

  • (optional)
    string

    Trace id, optional, useful when requesting support for abnormal behavior of requests.

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.
  • string
    OAuth 2.0 access token obtained from B2C PROD OAuth - v2 endpoint. Supported grant types: Authorization code.

Request body

{
  "assetsToEvaluateFor": [
    "string"
  ],
  "parameters": [
    {
      "parameterName": "string",
      "parameterValue": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "assetsToEvaluateFor": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "parameterName": {
            "type": "string",
            "nullable": true
          },
          "parameterValue": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "assetsToEvaluateFor": [
    "string"
  ],
  "parameters": [
    {
      "parameterName": "string",
      "parameterValue": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "assetsToEvaluateFor": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "parameterName": {
            "type": "string",
            "nullable": true
          },
          "parameterValue": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "assetsToEvaluateFor": [
    "string"
  ],
  "parameters": [
    {
      "parameterName": "string",
      "parameterValue": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "assetsToEvaluateFor": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "parameterName": {
            "type": "string",
            "nullable": true
          },
          "parameterValue": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}
{
  "assetsToEvaluateFor": [
    "string"
  ],
  "parameters": [
    {
      "parameterName": "string",
      "parameterValue": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "assetsToEvaluateFor": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "parameterName": {
            "type": "string",
            "nullable": true
          },
          "parameterValue": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

Responses

200 OK

Success

Representations

{
  "type": "object",
  "properties": {
    "Package": {
      "type": "object",
      "properties": {
        "Header": {
          "type": "object",
          "properties": {
            "ShipID": {
              "type": "string",
              "nullable": true
            },
            "AssetId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "DataChannelList": {
          "type": "object",
          "properties": {
            "dataChannel": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "DataChannelId": {
                    "type": "object",
                    "properties": {
                      "LocalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "UniversalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "ShortID": {
                        "type": "string",
                        "nullable": true
                      },
                      "Uuid": {
                        "type": "string",
                        "format": "uuid",
                        "nullable": true
                      },
                      "NameObject": {
                        "type": "object",
                        "properties": {
                          "NamingRule": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "LocalDataName": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "Property": {
                    "type": "object",
                    "properties": {
                      "DataChannelType": {
                        "type": "object",
                        "properties": {
                          "Type": {
                            "enum": [
                              "Inst",
                              "Average",
                              "Max",
                              "Min",
                              "StandardDeviation",
                              "Calculated",
                              "SetPoint",
                              "ControlOutput",
                              "Alert",
                              "Status",
                              "ManuallyInput"
                            ],
                            "type": "string"
                          },
                          "UpdateCycle": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "CalculationPeriod": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "MaxDelayInMinutes": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Format": {
                        "type": "object",
                        "properties": {
                          "FormatType": {
                            "enum": [
                              "Decimal",
                              "Integer",
                              "Boolean",
                              "String",
                              "DateTime"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      },
                      "Range": {
                        "type": "object",
                        "properties": {
                          "High": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "Low": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Unit": {
                        "type": "object",
                        "properties": {
                          "UnitSymbol": {
                            "type": "string",
                            "nullable": true
                          },
                          "QuantityName": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "QualityCoding": {
                        "type": "string",
                        "nullable": true
                      },
                      "Name": {
                        "type": "string",
                        "nullable": true
                      },
                      "Remarks": {
                        "type": "string",
                        "nullable": true
                      },
                      "Alias": {
                        "type": "string",
                        "nullable": true
                      },
                      "DataQuality": {
                        "type": "object",
                        "properties": {
                          "DataQualityID": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "TimeSeriesData": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "TabularData": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "NumberOfDataSet": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "NumberOfDataChannel": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "DataChannelID": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    },
                    "DataSet": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "TimeStamp": {
                            "type": "string",
                            "format": "date-time",
                            "nullable": true
                          },
                          "Value": {
                            "type": "array",
                            "items": {},
                            "nullable": true
                          },
                          "Quality": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "nullable": true
                          },
                          "Max": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Min": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Avg": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "nullable": true
              },
              "EventData": {
                "type": "object",
                "properties": {
                  "NumberOfDataSet": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "DataSet": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "TimeStamp": {
                          "type": "string",
                          "format": "date-time",
                          "nullable": true
                        },
                        "DataChannelID": {
                          "type": "string",
                          "nullable": true
                        },
                        "Value": {
                          "nullable": true
                        },
                        "Quality": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}
{
  "Package": {
    "Header": {
      "ShipID": "string",
      "AssetId": "string"
    },
    "DataChannelList": {
      "dataChannel": [
        {
          "DataChannelId": {
            "LocalID": "string",
            "UniversalID": "string",
            "ShortID": "string",
            "Uuid": "string",
            "NameObject": {
              "NamingRule": "string"
            },
            "LocalDataName": "string"
          },
          "Property": {
            "DataChannelType": {
              "Type": "Inst",
              "UpdateCycle": 0.0,
              "CalculationPeriod": 0.0,
              "MaxDelayInMinutes": 0.0
            },
            "Format": {
              "FormatType": "Decimal"
            },
            "Range": {
              "High": 0.0,
              "Low": 0.0
            },
            "Unit": {
              "UnitSymbol": "string",
              "QuantityName": "string"
            },
            "QualityCoding": "string",
            "Name": "string",
            "Remarks": "string",
            "Alias": "string",
            "DataQuality": {
              "DataQualityID": "string"
            }
          }
        }
      ]
    },
    "TimeSeriesData": [
      {
        "TabularData": [
          {
            "NumberOfDataSet": 0,
            "NumberOfDataChannel": 0,
            "DataChannelID": [
              "string"
            ],
            "DataSet": [
              {
                "TimeStamp": "string",
                "Value": [
                  {}
                ],
                "Quality": [
                  "string"
                ],
                "Max": [
                  0.0
                ],
                "Min": [
                  0.0
                ],
                "Avg": [
                  0.0
                ]
              }
            ]
          }
        ],
        "EventData": {
          "NumberOfDataSet": 0,
          "DataSet": [
            {
              "TimeStamp": "string",
              "DataChannelID": "string",
              "Value": {},
              "Quality": "string"
            }
          ]
        }
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "Package": {
      "type": "object",
      "properties": {
        "Header": {
          "type": "object",
          "properties": {
            "ShipID": {
              "type": "string",
              "nullable": true
            },
            "AssetId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "DataChannelList": {
          "type": "object",
          "properties": {
            "dataChannel": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "DataChannelId": {
                    "type": "object",
                    "properties": {
                      "LocalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "UniversalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "ShortID": {
                        "type": "string",
                        "nullable": true
                      },
                      "Uuid": {
                        "type": "string",
                        "format": "uuid",
                        "nullable": true
                      },
                      "NameObject": {
                        "type": "object",
                        "properties": {
                          "NamingRule": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "LocalDataName": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "Property": {
                    "type": "object",
                    "properties": {
                      "DataChannelType": {
                        "type": "object",
                        "properties": {
                          "Type": {
                            "enum": [
                              "Inst",
                              "Average",
                              "Max",
                              "Min",
                              "StandardDeviation",
                              "Calculated",
                              "SetPoint",
                              "ControlOutput",
                              "Alert",
                              "Status",
                              "ManuallyInput"
                            ],
                            "type": "string"
                          },
                          "UpdateCycle": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "CalculationPeriod": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "MaxDelayInMinutes": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Format": {
                        "type": "object",
                        "properties": {
                          "FormatType": {
                            "enum": [
                              "Decimal",
                              "Integer",
                              "Boolean",
                              "String",
                              "DateTime"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      },
                      "Range": {
                        "type": "object",
                        "properties": {
                          "High": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "Low": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Unit": {
                        "type": "object",
                        "properties": {
                          "UnitSymbol": {
                            "type": "string",
                            "nullable": true
                          },
                          "QuantityName": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "QualityCoding": {
                        "type": "string",
                        "nullable": true
                      },
                      "Name": {
                        "type": "string",
                        "nullable": true
                      },
                      "Remarks": {
                        "type": "string",
                        "nullable": true
                      },
                      "Alias": {
                        "type": "string",
                        "nullable": true
                      },
                      "DataQuality": {
                        "type": "object",
                        "properties": {
                          "DataQualityID": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "TimeSeriesData": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "TabularData": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "NumberOfDataSet": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "NumberOfDataChannel": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "DataChannelID": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    },
                    "DataSet": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "TimeStamp": {
                            "type": "string",
                            "format": "date-time",
                            "nullable": true
                          },
                          "Value": {
                            "type": "array",
                            "items": {},
                            "nullable": true
                          },
                          "Quality": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "nullable": true
                          },
                          "Max": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Min": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Avg": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "nullable": true
              },
              "EventData": {
                "type": "object",
                "properties": {
                  "NumberOfDataSet": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "DataSet": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "TimeStamp": {
                          "type": "string",
                          "format": "date-time",
                          "nullable": true
                        },
                        "DataChannelID": {
                          "type": "string",
                          "nullable": true
                        },
                        "Value": {
                          "nullable": true
                        },
                        "Quality": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}
{
  "Package": {
    "Header": {
      "ShipID": "string",
      "AssetId": "string"
    },
    "DataChannelList": {
      "dataChannel": [
        {
          "DataChannelId": {
            "LocalID": "string",
            "UniversalID": "string",
            "ShortID": "string",
            "Uuid": "string",
            "NameObject": {
              "NamingRule": "string"
            },
            "LocalDataName": "string"
          },
          "Property": {
            "DataChannelType": {
              "Type": "Inst",
              "UpdateCycle": 0.0,
              "CalculationPeriod": 0.0,
              "MaxDelayInMinutes": 0.0
            },
            "Format": {
              "FormatType": "Decimal"
            },
            "Range": {
              "High": 0.0,
              "Low": 0.0
            },
            "Unit": {
              "UnitSymbol": "string",
              "QuantityName": "string"
            },
            "QualityCoding": "string",
            "Name": "string",
            "Remarks": "string",
            "Alias": "string",
            "DataQuality": {
              "DataQualityID": "string"
            }
          }
        }
      ]
    },
    "TimeSeriesData": [
      {
        "TabularData": [
          {
            "NumberOfDataSet": 0,
            "NumberOfDataChannel": 0,
            "DataChannelID": [
              "string"
            ],
            "DataSet": [
              {
                "TimeStamp": "string",
                "Value": [
                  {}
                ],
                "Quality": [
                  "string"
                ],
                "Max": [
                  0.0
                ],
                "Min": [
                  0.0
                ],
                "Avg": [
                  0.0
                ]
              }
            ]
          }
        ],
        "EventData": {
          "NumberOfDataSet": 0,
          "DataSet": [
            {
              "TimeStamp": "string",
              "DataChannelID": "string",
              "Value": {},
              "Quality": "string"
            }
          ]
        }
      }
    ]
  }
}
{
  "type": "object",
  "properties": {
    "Package": {
      "type": "object",
      "properties": {
        "Header": {
          "type": "object",
          "properties": {
            "ShipID": {
              "type": "string",
              "nullable": true
            },
            "AssetId": {
              "type": "string",
              "format": "uuid",
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "DataChannelList": {
          "type": "object",
          "properties": {
            "dataChannel": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "DataChannelId": {
                    "type": "object",
                    "properties": {
                      "LocalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "UniversalID": {
                        "type": "string",
                        "nullable": true
                      },
                      "ShortID": {
                        "type": "string",
                        "nullable": true
                      },
                      "Uuid": {
                        "type": "string",
                        "format": "uuid",
                        "nullable": true
                      },
                      "NameObject": {
                        "type": "object",
                        "properties": {
                          "NamingRule": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "LocalDataName": {
                        "type": "string",
                        "nullable": true
                      }
                    },
                    "additionalProperties": false
                  },
                  "Property": {
                    "type": "object",
                    "properties": {
                      "DataChannelType": {
                        "type": "object",
                        "properties": {
                          "Type": {
                            "enum": [
                              "Inst",
                              "Average",
                              "Max",
                              "Min",
                              "StandardDeviation",
                              "Calculated",
                              "SetPoint",
                              "ControlOutput",
                              "Alert",
                              "Status",
                              "ManuallyInput"
                            ],
                            "type": "string"
                          },
                          "UpdateCycle": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "CalculationPeriod": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "MaxDelayInMinutes": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Format": {
                        "type": "object",
                        "properties": {
                          "FormatType": {
                            "enum": [
                              "Decimal",
                              "Integer",
                              "Boolean",
                              "String",
                              "DateTime"
                            ],
                            "type": "string"
                          }
                        },
                        "additionalProperties": false
                      },
                      "Range": {
                        "type": "object",
                        "properties": {
                          "High": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          },
                          "Low": {
                            "type": "number",
                            "format": "double",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "Unit": {
                        "type": "object",
                        "properties": {
                          "UnitSymbol": {
                            "type": "string",
                            "nullable": true
                          },
                          "QuantityName": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "QualityCoding": {
                        "type": "string",
                        "nullable": true
                      },
                      "Name": {
                        "type": "string",
                        "nullable": true
                      },
                      "Remarks": {
                        "type": "string",
                        "nullable": true
                      },
                      "Alias": {
                        "type": "string",
                        "nullable": true
                      },
                      "DataQuality": {
                        "type": "object",
                        "properties": {
                          "DataQualityID": {
                            "type": "string",
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "additionalProperties": false
              },
              "nullable": true
            }
          },
          "additionalProperties": false
        },
        "TimeSeriesData": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "TabularData": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "NumberOfDataSet": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "NumberOfDataChannel": {
                      "type": "integer",
                      "format": "int32"
                    },
                    "DataChannelID": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    },
                    "DataSet": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "TimeStamp": {
                            "type": "string",
                            "format": "date-time",
                            "nullable": true
                          },
                          "Value": {
                            "type": "array",
                            "items": {},
                            "nullable": true
                          },
                          "Quality": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            },
                            "nullable": true
                          },
                          "Max": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Min": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          },
                          "Avg": {
                            "type": "array",
                            "items": {
                              "type": "number",
                              "format": "double"
                            },
                            "nullable": true
                          }
                        },
                        "additionalProperties": false
                      },
                      "nullable": true
                    }
                  },
                  "additionalProperties": false
                },
                "nullable": true
              },
              "EventData": {
                "type": "object",
                "properties": {
                  "NumberOfDataSet": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "DataSet": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "TimeStamp": {
                          "type": "string",
                          "format": "date-time",
                          "nullable": true
                        },
                        "DataChannelID": {
                          "type": "string",
                          "nullable": true
                        },
                        "Value": {
                          "nullable": true
                        },
                        "Quality": {
                          "type": "string",
                          "nullable": true
                        }
                      },
                      "additionalProperties": false
                    },
                    "nullable": true
                  }
                },
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          },
          "nullable": true
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute"
-H "x-requestidentifier: "
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("x-requestidentifier", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "{access token}");

            var uri = "https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("x-requestidentifier", "");
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "{access token}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("x-requestidentifier","");
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","{access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"x-requestidentifier"];
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    [_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'x-requestidentifier' => '',
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'x-requestidentifier': '',
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'x-requestidentifier': '',
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
    'Authorization': '{access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.veracity.com')
    conn.request("POST", "/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.veracity.com/veracity/timeseries2/api/v2/StoredProcedure/{procedureName}/.execute')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['x-requestidentifier'] = ''
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body