Detailed Measurement Book

Overview

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

API Specifications

API Contract Link

Swagger Editor

APIs

/measurement/v1/_create

Create one or more measurement entries

POST/measurement/v1/_create

Body

application/json

requestInfoRequestInfo (object)

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.

measurementsarray of Measurement (object)

Response

202400

Accepted create measurement request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of Measurement (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurement/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "measurementNumber": "text",
      "physicalRefNumber": "text",
      "referenceId": "Contract number",
      "entryDate": 0,
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 0,
          "cumulativeValue": 0,
          "isActive": false,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "isActive": true,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

/measurement/v1/_update

Update one or more measurement entries

POST/measurement/v1/_update

Body

application/json

requestInfoRequestInfo (object)

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.

measurementsarray of Measurement (object)

Response

200400

Accepted update measurement request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of Measurement (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurement/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "measurementNumber": "text",
      "physicalRefNumber": "text",
      "referenceId": "Contract number",
      "entryDate": 0,
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 0,
          "cumulativeValue": 0,
          "isActive": false,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "isActive": true,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

/measurement/v1/_search

Search values in a measurement book

POST/measurement/v1/_search

Body

application/json

requestInfoRequestInfo (object)

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.

criteriaMeasurementCriteria (object)

paginationPagination (object)

Pagination details

Response

200400

Accepted update measurement book request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of Measurement (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurement/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "id": "251c51eb-e970-4e01-a99a-70136c47a934",
      "tenantId": "pb.jalandhar,dwss",
      "measurementNumber": "text",
      "physicalRefNumber": "text",
      "referenceId": "Contract number",
      "entryDate": 0,
      "measures": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "referenceId": "measurementId",
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 0,
          "cumulativeValue": 0,
          "isActive": false,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text"
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 0,
            "lastModifiedTime": 0
          }
        }
      ],
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text"
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 0,
        "lastModifiedTime": 0
      }
    }
  ]
}

/measurementservice/v1/_create

Creates a measurement entry along with workflow details.

POST/measurementservice/v1/_create

Body

application/json

requestInfoRequestInfo (object)

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.

measurementsarray of MeasurementService (object)

Response

202400

Accepted create measurement book request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of MeasurementService (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurementservice/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

202400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "allOf": {
        "id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "measurementNumber": "text",
        "physicalRefNumber": "text",
        "referenceId": "Contract number",
        "entryDate": 0,
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 0,
            "cumulativeValue": 0,
            "isActive": false,
            "comments": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 0,
              "lastModifiedTime": 0
            }
          }
        ],
        "isActive": true,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 0,
          "lastModifiedTime": 0
        }
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      }
    }
  ]
}

/measurementservice/v1/_update

Update values in a measurement book

POST/measurementservice/v1/_update

Body

application/json

requestInfoRequestInfo (object)

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.

measurementsarray of MeasurementService (object)

Response

200400

Accepted update measurement book request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of MeasurementService (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurementservice/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "allOf": {
        "id": "251c51eb-e970-4e01-a99a-70136c47a934",
        "measurementNumber": "text",
        "physicalRefNumber": "text",
        "referenceId": "Contract number",
        "entryDate": 0,
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 0,
            "cumulativeValue": 0,
            "isActive": false,
            "comments": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text"
              }
            ],
            "auditDetails": {
              "createdBy": "text",
              "lastModifiedBy": "text",
              "createdTime": 0,
              "lastModifiedTime": 0
            }
          }
        ],
        "isActive": true,
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text",
          "createdTime": 0,
          "lastModifiedTime": 0
        }
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      }
    }
  ]
}

/measurementservice/v1/_search

Search values in a measurement book

POST/measurementservice/v1/_search

Body

application/json

requestInfoRequestInfo (object)

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.

criteriaMeasurementCriteria (object)

paginationPagination (object)

Pagination details

Response

200400

Accepted update measurement book request.

Body

*/*

responseInfoResponseInfo (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

measurementsarray of MeasurementService (object)

Request

JavaScriptCurlPython

const response = await fetch('/measurementservice/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 0,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "measurements": [
    {
      "wfStatus": "text",
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ]
      }
    }
  ]
}

Data Model

DB Schema Diagram

Web Sequence Diagrams

Measurement Registry

Create

Update

Search

Measurement Service

Create

Update

Search

Related Topics

1. Functional Specifications - Measurement Book

2. Detailed Measurement Book User Stories

3. Measurement Book UI Configuration