Detailed Measurement Book

PreviousExpense NextFunctional Specifications

Last updated 1 year ago

Was this helpful?

/measurement/v1/_create

post

Create one or more measurement entries

Body

Encapsulates a measurement entry request

Responses

202

Accepted create measurement request.

*/*

400

Invalid input.

*/*

post

POST /measurement/v1/_create HTTP/1.1
Host: 
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

Encapsulates a measurement entry request

Responses

200

Accepted update measurement request.

*/*

400

Invalid input.

*/*

post

POST /measurement/v1/_update HTTP/1.1
Host: 
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

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

Responses

202

Accepted create measurement book request.

*/*

400

Invalid input.

*/*

post

POST /measurementservice/v1/_create HTTP/1.1
Host: 
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

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

Responses

200

Accepted update measurement book request.

*/*

400

Invalid input.

*/*

post

POST /measurementservice/v1/_update HTTP/1.1
Host: 
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"
        ]
      }
    }
  ]
}

/measurement/v1/_search

post

Search values in a measurement book

Body

Responses

200

Accepted update measurement book request.

*/*

400

Invalid input.

*/*

post

POST /measurement/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "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": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

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

/measurementservice/v1/_search

post

Search values in a measurement book

Body

Responses

200

Accepted update measurement book request.

*/*

400

Invalid input.

*/*

post

POST /measurementservice/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 314

{
  "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": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {
      "0": "a",
      "1": "s",
      "2": "c"
    }
  }
}

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

Detailed Measurement Book

Detailed Measurement Book

Overview

API Specifications

API Contract Link

APIs

Data Model

DB Schema Diagram

Web Sequence Diagrams

Measurement Registry

Measurement Service

Overview

API Specifications

API Contract Link

APIs

Data Model

DB Schema Diagram

Web Sequence Diagrams

Measurement Registry

Measurement Service

/measurement/v1/_create

/measurement/v1/_update

/measurementservice/v1/_create

/measurementservice/v1/_update

/measurement/v1/_search

/measurementservice/v1/_search

Overview

API Specifications

API Contract Link

APIs

Data Model

DB Schema Diagram

Web Sequence Diagrams

Measurement Registry

Measurement Service

Related Topics

Overview

API Specifications

API Contract Link

APIs

Data Model

DB Schema Diagram

Web Sequence Diagrams

Measurement Registry

Measurement Service

Related Topics

/measurement/v1/_create

/measurement/v1/_update

/measurementservice/v1/_create

/measurementservice/v1/_update

/measurement/v1/_search

/measurementservice/v1/_search