GET Reporting API
  1. ProjectTemplate
GET Reporting API
  • Basic Information
  • ProjectJobs
    • ProjectJobs_GetStatus
      GET
    • ProjectJobs_GetResult
      GET
  • ProjectTemplate
    • ProjectTemplate_Get
      GET
    • ProjectTemplate_Build
      POST
  • GlobalJobs
    • GlobalJobs_GetStatus
      GET
    • GlobalJobs_GetResult
      GET
  • GlobalTemplate
    • GlobalTemplate_Get
      GET
    • GlobalTemplate_Build
      POST
  • Schemas
    • Schemas
      • JobStatusResponse
      • JobStatusEnum
      • QueryResultResponse
      • GetTemplateInfoResponse
      • TemplateFieldInfo
      • TemplateFieldDataTypeEnum
      • TemplateFieldModeEnum
      • BuildTemplateRequest
      • BuildTemplateParameter
      • BuildTemplateParameterTypeEnum
  1. ProjectTemplate

ProjectTemplate_Build

POST
/api/projects/{projectId}/templates/{templateId}/build

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://report-api.get.systems/api/projects/abcdef01-2345-6789-abcd-ef0123456789/templates/abcdef01-2345-6789-abcd-ef0123456789/build' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "parameters": [
        {
            "name": "string",
            "dataType": "Bool",
            "value": "string"
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "jobId": "abcdef01-2345-6789-abcd-ef0123456789",
    "status": "Initialized",
    "errorMessage": "string",
    "templateId": "abcdef01-2345-6789-abcd-ef0123456789"
}
Modified at 2025-02-06 16:24:46
Previous
ProjectTemplate_Get
Next
GlobalJobs_GetStatus
Built with