Detailed Measurement Book

Overview

The measurement book is a measure of progress in a Works contract. This service

API Specifications

API Contract Link

APIs

Data Model

DB Schema Diagram

TBD

Web Sequence Diagrams

Measurement Registry

Measurement Service

PreviousSchedule of Rates (archive)NextInstall Works

Was this helpful?

/measurement/v1/_create

Create one or more measurement entries

post

/measurement/v1/_create

Body

requestInfoobject

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

measurementsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/measurement/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"measurements":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","referenceId":"Contract number","entryDate":1,"isActive":true,"auditDetails":{},"additionalDetails":{},"measures":[{"targetId":"contractlineitemid","length":200,"breadth":200,"height":200,"numItems":1,"currentValue":1,"auditDetails":{},"additionalDetails":{},"documents":[{"additionalDetails":{}}]}]}]}'

202

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "measurementNumber": "text",
      "physicalRefNumber": "text",
      "referenceId": "Contract number",
      "entryDate": 1,
      "isActive": true,
      "auditDetails": {},
      "additionalDetails": {},
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "auditDetails": {},
          "additionalDetails": {},
          "documents": [
            {
              "additionalDetails": {}
            }
          ]
        }
      ]
    }
  ]
}

Accepted create measurement request.

/measurement/v1/_update

Update one or more measurement entries

post

/measurement/v1/_update

Body

requestInfoobject

measurementsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/measurement/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"measurements":[{"id":"251c51eb-e970-4e01-a99a-70136c47a934","referenceId":"Contract number","entryDate":1,"isActive":true,"auditDetails":{},"additionalDetails":{},"measures":[{"targetId":"contractlineitemid","length":200,"breadth":200,"height":200,"numItems":1,"currentValue":1,"auditDetails":{},"additionalDetails":{},"documents":[{"additionalDetails":{}}]}]}]}'

200

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "measurementNumber": "text",
      "physicalRefNumber": "text",
      "referenceId": "Contract number",
      "entryDate": 1,
      "isActive": true,
      "auditDetails": {},
      "additionalDetails": {},
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "auditDetails": {},
          "additionalDetails": {},
          "documents": [
            {
              "additionalDetails": {}
            }
          ]
        }
      ]
    }
  ]
}

Accepted update measurement request.

/measurementservice/v1/_create

Creates a measurement entry along with workflow details.

post

/measurementservice/v1/_create

Body

requestInfoobject

measurementsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/measurementservice/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"measurements":[{"allOf":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","referenceId":"Contract number","entryDate":1,"isActive":true,"auditDetails":{},"additionalDetails":{},"measures":[{"targetId":"contractlineitemid","length":200,"breadth":200,"height":200,"numItems":1,"currentValue":1,"auditDetails":{},"additionalDetails":{},"documents":[{"additionalDetails":{}}]}]},"workflow":{"action":"text","assignees":[null]}}]}'

202

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "allOf": {
        "id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "referenceId": "Contract number",
        "entryDate": 1,
        "isActive": true,
        "auditDetails": {},
        "additionalDetails": {},
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 1,
            "auditDetails": {},
            "additionalDetails": {},
            "documents": [
              {
                "additionalDetails": {}
              }
            ]
          }
        ]
      },
      "workflow": {
        "action": "text",
        "assignees": [
          null
        ]
      }
    }
  ]
}

Accepted create measurement book request.

/measurementservice/v1/_update

Update values in a measurement book

post

/measurementservice/v1/_update

Body

requestInfoobject

measurementsobject[]

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/measurementservice/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"requestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","roles":[{"tenantId":"text"}]}},"measurements":[{"allOf":{"id":"251c51eb-e970-4e01-a99a-70136c47a934","referenceId":"Contract number","entryDate":1,"isActive":true,"auditDetails":{},"additionalDetails":{},"measures":[{"targetId":"contractlineitemid","length":200,"breadth":200,"height":200,"numItems":1,"currentValue":1,"auditDetails":{},"additionalDetails":{},"documents":[{"additionalDetails":{}}]}]},"workflow":{"action":"text","assignees":[null]}}]}'

200

400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "allOf": {
        "id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "referenceId": "Contract number",
        "entryDate": 1,
        "isActive": true,
        "auditDetails": {},
        "additionalDetails": {},
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 1,
            "auditDetails": {},
            "additionalDetails": {},
            "documents": [
              {
                "additionalDetails": {}
              }
            ]
          }
        ]
      },
      "workflow": {
        "action": "text",
        "assignees": [
          null
        ]
      }
    }
  ]
}

Accepted update measurement book request.