1 of 1

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

Detailed Measurement Book

Overview

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

API Specifications

API Contract Link

APIs

/measurement/v1/_create

Create one or more measurement entries

POST/measurement/v1/_create

Body

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.

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Response

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.

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Request

Response

/measurement/v1/_update

Update one or more measurement entries

POST/measurement/v1/_update

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Response

Accepted update measurement request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Request

Response

/measurementservice/v1/_create

Creates a measurement entry along with workflow details.

POST/measurementservice/v1/_create

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Response

Accepted create measurement book request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Request

Response

/measurementservice/v1/_update

Update values in a measurement book

POST/measurementservice/v1/_update

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Response

Accepted update measurement book request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Request

Response

Data Model

DB Schema Diagram

TBD

Web Sequence Diagrams

Measurement Registry

Measurement Service

/measurement/v1/_create

Create one or more measurement entries

POST/measurement/v1/_create

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Response

Accepted create measurement request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Request

Response

/measurementservice/v1/_create

Creates a measurement entry along with workflow details.

POST/measurementservice/v1/_create

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Response

Accepted create measurement book request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Request

Response

/measurement/v1/_update

Update one or more measurement entries

POST/measurement/v1/_update

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Response

Accepted update measurement request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of Measurement (object)

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

Request

Response

/measurementservice/v1/_update

Update values in a measurement book

POST/measurementservice/v1/_update

Body

requestInfoRequestInfo (object)

apiId*string

unique API ID

ver*string

API version - for HTTP based request this will be same as used in path

ts*integer (int64)

time in epoch

action*string

API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc

didstring

Device ID from which the API is called

keystring

API key (API key provided to the caller in case of server to server communication)

msgId*string

Unique request message id from the caller

requesterIdstring

UserId of the user calling

authTokenstring

//session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token

userInfoUser (object)

This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.

tenantId*string

Unique Identifier of the tenant to which user primarily belongs

idinteger (int32)

User id of the authenticated user. Will be deprecated in future

uuidstring

UUID of the user

userName*string

Unique user name of the authenticated user

mobileNumberstring

mobile number of the autheticated user

emailIdstring

email address of the authenticated user

roles*array of Role (object)

List of all the roles

tenantId*string

TenantId for which the role is given

idstring (int32)

id of the role

namestring

Unique name of the role

descriptionstring

brief description of the role

correlationIdstring

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Response

Accepted update measurement book request.

Body

responseInfoResponseInfo (object)

apiId*string

unique API ID

ver*string

API version

ts*integer (int64)

response time in epoch

resMsgIdstring

unique response message id (UUID) - will usually be the correlation id from the server

msgIdstring

message id of the request

status*enum

status of request processing - to be enhanced in futuer to include INPROGRESS

SUCCESSFULFAILED

measurementsarray of MeasurementService (object)

allOfMeasurement (object)

This defines a measurement with or without detailed measures.

idstring (uuid)

Unique identifier of the detailed measurement entry

Example: "251c51eb-e970-4e01-a99a-70136c47a934"

measurementNumberstring

Formatted number for this entry

physicalRefNumberstring

Reference to a real world mBook or file or docket. Optional attribute.

referenceId*string

The entity to which this measurement belongs or is related to

Example: "Contract number"

entryDate*number (timestamp)

Date (in epoch time) when measurement was taken if different from the system created time

measuresarray of Measure (object)

targetId*string

The item which is being measured.

Example: "contractlineitemid"

lengthnumber

Measured length if applicable

Example: 200

breadthnumber

Measured breadth if applicable

Example: 200

heightnumber

Measured height if applicable

Example: 200

numItemsnumber

Number of items with same dimensions

currentValue*number

Derived from LBHQ as LBH*Q or can be entered directly without LBHQ measurements.

cumulativeValuenumber

Sum of all measurements so far for a given targetId

isActiveboolean

Flag for soft deletion

commentsstring

Any observational comments made during measurement

documentsarray of Document (object)

Reference to documents related to the organisation that have been attached via file upload

idstring

system id of the Document.

documentTypestring

unique document type code, should be validated with document type master

fileStorestring

File store reference key.

documentUidstring

The unique id(Pancard Number,Adhar etc.) of the given Document.

additionalDetailsobject

Json object to capture any extra information which is not accommodated by model

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

isActiveboolean

Flag used to soft delete entries

auditDetailsAuditDetails (object)

Collection of audit related fields used by most models

createdBystring

username (preferred) or userid of the user that created the object

lastModifiedBystring

username (preferred) or userid of the user that last modified the object

createdTimeinteger (int64)

epoch of the time object is created

lastModifiedTimeinteger (int64)

epoch of the time object is last modified

additionalDetailsobject

Any additional information that needs to be attached to the estimate. For attachments, fileStoreIds will also be stored here.

workflowWorkflow (object)

action*string

Action of the workflow to be performned on the request

commentstring

comment for the workflow action to be performed

assigneesarray of string

itemsstring

Request

Response

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

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

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

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

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

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

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

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