Detailed Measurement Book

Overview

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

API Specifications

API Contract Link

11KB

Measurement-Book-v1.0.0.yaml

Open

APIs

/measurement/v1/_create

post

Create one or more measurement entries

Body

application/json

Encapsulates a measurement entry request

Responses

202

Accepted create measurement request.

*/*

400

Invalid input.

*/*

post

/measurement/v1/_create

HTTPcURLJavaScriptPython

POST /measurement/v1/_create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "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": {}
    }
  ]
}

{
  "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": {}
    }
  ]
}

/measurement/v1/_update

post

Update one or more measurement entries

Body

application/json

Encapsulates a measurement entry request

Responses

200

Accepted update measurement request.

*/*

Encapsulates a measurement response

400

Invalid input.

*/*

post

/measurement/v1/_update

HTTPcURLJavaScriptPython

POST /measurement/v1/_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 587

{
  "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": {}
    }
  ]
}

{
  "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": {}
    }
  ]
}

/measurementservice/v1/_create

post

Creates a measurement entry along with workflow details.

Body

application/json

Encapsulates a measurement book service request. Takes a singleton along with workflow.

Responses

202

Accepted create measurement book request.

*/*

400

Invalid input.

*/*

post

/measurementservice/v1/_create

HTTPcURLJavaScriptPython

POST /measurementservice/v1/_create HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 664

{
  "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"
        ]
      }
    }
  ]
}

{
  "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"
        ]
      }
    }
  ]
}

/measurementservice/v1/_update

post

Update values in a measurement book

Body

application/json

Encapsulates a measurement book service request. Takes a singleton along with workflow.

Responses

200

Accepted update measurement book request.

*/*

Encapsulates a measurement service response. Returns an array of measurements with workflow.

400

Invalid input.

*/*

post

/measurementservice/v1/_update

HTTPcURLJavaScriptPython

POST /measurementservice/v1/_update HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 664

{
  "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"
        ]
      }
    }
  ]
}

{
  "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"
        ]
      }
    }
  ]
}

Data Model

DB Schema Diagram

TBD

Web Sequence Diagrams

Measurement Registry

Create

Update

Search

Measurement Service

Create

Update

Search