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

post

Create one or more measurement entries

Body

requestInfoobjectoptional

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[] · min: 1optional

This defines a measurement with or without detailed measures.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurement/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "measurements": [
      {
        "physicalRefNumber": "text",
        "referenceId": "Contract number",
        "entryDate": 1,
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 1,
            "cumulativeValue": 1,
            "isActive": true,
            "comments": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ],
            "additionalDetails": {}
          }
        ],
        "isActive": true,
        "additionalDetails": {}
      }
    ]
  }'

202

400

202

{
  "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,
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "cumulativeValue": 1,
          "isActive": true,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ],
      "isActive": true,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

Accepted create measurement request.

/measurement/v1/_update

post

Update one or more measurement entries

Body

requestInfoobjectoptional

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[] · min: 1optional

This defines a measurement with or without detailed measures.

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurement/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "measurements": [
      {
        "physicalRefNumber": "text",
        "referenceId": "Contract number",
        "entryDate": 1,
        "measures": [
          {
            "targetId": "contractlineitemid",
            "length": 200,
            "breadth": 200,
            "height": 200,
            "numItems": 1,
            "currentValue": 1,
            "cumulativeValue": 1,
            "isActive": true,
            "comments": "text",
            "documents": [
              {
                "id": "text",
                "documentType": "text",
                "fileStore": "text",
                "documentUid": "text",
                "additionalDetails": {}
              }
            ],
            "additionalDetails": {}
          }
        ],
        "isActive": true,
        "additionalDetails": {}
      }
    ]
  }'

200

400

200

{
  "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,
      "measures": [
        {
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "cumulativeValue": 1,
          "isActive": true,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ],
      "isActive": true,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

Accepted update measurement request.

/measurement/v1/_search

post

Search values in a measurement book

Body

requestInfoobjectoptional

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.

criteriaobjectoptional

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurement/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "criteria": {
      "referenceId": [
        "text"
      ],
      "measurementNumber": "text",
      "ids": [
        "text"
      ]
    },
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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": 1,
      "measures": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "referenceId": "measurementId",
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "cumulativeValue": 1,
          "isActive": true,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ],
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

Accepted update measurement book request.

/measurementservice/v1/_create

post

Creates a measurement entry along with workflow details.

Body

requestInfoobjectoptional

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[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurementservice/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "measurements": [
      {
        "allOf": {
          "physicalRefNumber": "text",
          "referenceId": "Contract number",
          "entryDate": 1,
          "measures": [
            {
              "targetId": "contractlineitemid",
              "length": 200,
              "breadth": 200,
              "height": 200,
              "numItems": 1,
              "currentValue": 1,
              "cumulativeValue": 1,
              "isActive": true,
              "comments": "text",
              "documents": [
                {
                  "id": "text",
                  "documentType": "text",
                  "fileStore": "text",
                  "documentUid": "text",
                  "additionalDetails": {}
                }
              ],
              "additionalDetails": {}
            }
          ],
          "isActive": true,
          "additionalDetails": {}
        },
        "workflow": {
          "action": "text",
          "comment": "text",
          "assignees": [
            "text"
          ]
        }
      }
    ]
  }'

202

400

202

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

Accepted create measurement book request.

/measurementservice/v1/_update

post

Update values in a measurement book

Body

requestInfoobjectoptional

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[]optional

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurementservice/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "measurements": [
      {
        "allOf": {
          "physicalRefNumber": "text",
          "referenceId": "Contract number",
          "entryDate": 1,
          "measures": [
            {
              "targetId": "contractlineitemid",
              "length": 200,
              "breadth": 200,
              "height": 200,
              "numItems": 1,
              "currentValue": 1,
              "cumulativeValue": 1,
              "isActive": true,
              "comments": "text",
              "documents": [
                {
                  "id": "text",
                  "documentType": "text",
                  "fileStore": "text",
                  "documentUid": "text",
                  "additionalDetails": {}
                }
              ],
              "additionalDetails": {}
            }
          ],
          "isActive": true,
          "additionalDetails": {}
        },
        "workflow": {
          "action": "text",
          "comment": "text",
          "assignees": [
            "text"
          ]
        }
      }
    ]
  }'

200

400

200

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

Accepted update measurement book request.

/measurementservice/v1/_search

post

Search values in a measurement book

Body

requestInfoobjectoptional

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.

criteriaobjectoptional

paginationobjectoptional

Pagination details

Responses

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/measurementservice/v1/_search' \
  --header 'Content-Type: application/json' \
  --data '{
    "requestInfo": {
      "apiId": "text",
      "ver": "text",
      "ts": 1,
      "action": "text",
      "did": "text",
      "key": "text",
      "msgId": "text",
      "requesterId": "text",
      "authToken": "text"
    },
    "criteria": {
      "referenceId": [
        "text"
      ],
      "measurementNumber": "text",
      "ids": [
        "text"
      ]
    },
    "pagination": {
      "limit": 1,
      "offSet": 1,
      "sortBy": "text",
      "order": {
        "0": "a",
        "1": "s",
        "2": "c"
      }
    }
  }'

200

400

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "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": 1,
      "measures": [
        {
          "id": "251c51eb-e970-4e01-a99a-70136c47a934",
          "referenceId": "measurementId",
          "targetId": "contractlineitemid",
          "length": 200,
          "breadth": 200,
          "height": 200,
          "numItems": 1,
          "currentValue": 1,
          "cumulativeValue": 1,
          "isActive": true,
          "comments": "text",
          "documents": [
            {
              "id": "text",
              "documentType": "text",
              "fileStore": "text",
              "documentUid": "text",
              "additionalDetails": {}
            }
          ],
          "auditDetails": {
            "createdBy": "text",
            "lastModifiedBy": "text",
            "createdTime": 1,
            "lastModifiedTime": 1
          },
          "additionalDetails": {}
        }
      ],
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalDetails": {}
    }
  ]
}

Accepted update measurement book request.

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