Skip to content

Retrieve Assignment Template JSON

Request

Fetches the assignment template in JSON format based on the provided assignment ID and upload ID. A valid authorization token is required for the request. The response contains the assignment template as a CollectionMetricReqRes object.

Security
Bearer
Query
assignmentIdinteger, (int32)required

The unique identifier for the assignment

uploadIdinteger, (int32)required

The unique identifier for the upload associated with the assignment

curl -i -X GET \
  'https://developer.sustainabilitymaster.ai/_mock/openapi/api/DataCollection/InstantAssignmentTemplate?assignmentId=0&uploadId=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully retrieved the assignment template in JSON format for the specified assignment ID and upload ID

Bodyapplication/json
Array [
metricNamestring or null

The name of the collection metric (e.g., "Total Nos of Employee Count").

Example:"Total Nos of Employee Count"
metricIdinteger, (int32)

The unique ID for the metric.

Example:5244
metricGuidstring, (uuid)

The GUID associated with the metric, used for unique identification.

Example:"99384ade-09db-4219-ae19-81b0321cb727"
dimensionsArray of objects or null(CollectionMetricDimReqRes)

A list of dimensions associated with the collection metric. Each dimension contains further details related to the metric.

Example:
[
  {
    "Country": "USA",
    "Company": "GlobalEco Corporation",
    "Department": "HR",
    "Location": "New York",
    "BusinessUnit": "North America",
    "Month": "March",
    "Year": 2025,
    "Value": 1000,
    "NotAvailable": false
  }
]
]
Response
[
  {
    "metricName": "Total Nos of Employee Count",
    "metricId": 5244,
    "metricGuid": "99384ade-09db-4219-ae19-81b0321cb727",
    "dimensions": [ … ]
  }
]