OriginatedCPS API

get originated CPS chart for account during time period

POST /api/rest/customer/v1/chart-originated-cps

Parameters

Name	Description
data[type]	Resource type (chart-originated-cps)
data[attributes][from-time]	From time
data[attributes][to-time]	To time
data[relationships][account]	Account

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5LCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzQwODUyNTA1fQ.ne2CIeBwogHfiqzAK8PhGHu-tW4yZikg2EQuWLrC4zw
Host: example.org
Cookie: 

Route

POST /api/rest/customer/v1/chart-originated-cps

Body

{"data":{"type":"chart-originated-cps","attributes":{"from-time":"2019-01-01 00:00:00","to-time":"2019-01-02 00:00:00"},"relationships":{"account":{"data":{"type":"accounts","id":"07575b9a-f6c8-11ef-b447-0242ac120003"}}}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"eb7689d8a7a45905f398ad80bc00f9c3"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 3dd208ac-6187-4182-b06b-7547820ffa14
X-Runtime: 0.014928
Content-Length: 630

Status

201 Created

Body

{
  "data": {
    "id": "85d2c136-bada-426d-8b20-dfe6ef9ad28b",
    "type": "chart-originated-cps",
    "links": {
      "self": "http://example.org/api/rest/customer/v1/chart-originated-cps/85d2c136-bada-426d-8b20-dfe6ef9ad28b"
    },
    "attributes": {
      "from-time": "2019-01-01T00:00:00.000Z",
      "to-time": "2019-01-02T00:00:00.000Z",
      "cps": [
        {
          "y": "0.2",
          "x": "2019-01-01T23:59:00.000Z"
        }
      ]
    },
    "relationships": {
      "account": {
        "links": {
          "self": "http://example.org/api/rest/customer/v1/chart-originated-cps/85d2c136-bada-426d-8b20-dfe6ef9ad28b/relationships/account",
          "related": "http://example.org/api/rest/customer/v1/chart-originated-cps/85d2c136-bada-426d-8b20-dfe6ef9ad28b/account"
        }
      }
    }
  }
}