API DocsRESTReport template service

GetReportTemplate

Retrieve a report template.

GET
/api/v1/report-templates/{reportTemplateId}

Path Parameters

reportTemplateId
Required
string

Query Parameters

clientKeystring

organizationIdstring

curl -X GET "<API_URL>/api/v1/report-templates/string?clientKey=string&organizationId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "reportTemplate": {
    "reportTemplateId": "string",
    "organizationId": "string",
    "clientKey": "string",
    "name": "string",
    "description": "string",
    "archivedDate": "2019-08-24T14:15:22Z",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "rules": [
      {
        "ruleId": "string",
        "ruleVersionId": "string",
        "ruleVersionNumber": 0,
        "clientKey": "string"
      }
    ],
    "tags": [
      {
        "tagName": "string"
      }
    ]
  }
}

Previous

CreateReportTemplate POST

Next

GetReportTemplate GET