Add a report

Add a report

application/json

Request Body required

addMiscReportRequest

category string
dealerAccessMap object
property name* string
enableReportLibraryDso boolean
featureKeyList string[]
helpText string
reportBaseUrl string
reportName string
tokenCount int32

Responses

• 200
• 201
• 401
• 403
• 404

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
status string
warning object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "status": "string",
  "warning": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /library/report

Request

Base URL

//api.mykaarma.com/reporting/v2

Body required

{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

python / requests

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

go / native

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/reporting/v2/library/report' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "category": "string",
  "dealerAccessMap": {},
  "enableReportLibraryDso": true,
  "featureKeyList": [
    "string"
  ],
  "helpText": "string",
  "reportBaseUrl": "string",
  "reportName": "string",
  "tokenCount": 0
}'