describe

Prev Next
Get
/sys-rest-api/rest/1/weightMeasureConversion/describe

Overview

This endpoint retrieves all Weight Measure Conversion Codes.


Notes

  • Authentication and authorization are required.

  • If weight measure code does not exist or is not accessible, an appropriate error is returned.


UI Navigation

System Data -> Global tables -> Weight Measure


Finders

  • The following finders are available for data filtering and optimizing request performance.

N/A


Query Standards

Key Recommended Description
finder Yes Filters data based on attributes. See finder details below. Finders can be combined using a comma delimiter between parameters that implies an "and" statement. For more information on using the finder functionality, please see [Best Practice
limit Yes A limit restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count, then the framework will return all available resources. For additional information on using the limit functionality, please visit [Best Practice
offset Yes The offset skips a specified number of items in a data list before it starts showing results. For example, if you set an offset of 10, it skips the first 10 items and begins showing from the 11th item. For additional information on using offset functionality, please visit [Best Practice
orderBy Yes The orderBy attribute retrieves rows using an order ensuring the response payload displays data in the order supplied in the URL parameter using the GET method. For more information on using orderBy functionality, please visit [Best Practice

Attributes

CMiC UI Fieldname Object Name Description Type Data Length Example
WcWmToCode weightMeasureConversion WcWmToCode Weight Measure To Code String 2 KG
WcWmFromName weightMeasureConversion WcWmFromName Weight Measure Name String 10 Gram
WcWmFromCode weightMeasureConversion WcWmFromCode Weight Measure From Code String 2 KG
WcWmToName weightMeasureConversion WcWmToName Weight Measure Name String 10 Gram
WcConvNum weightMeasureConversion WcConvNum Conversion Factor Number 12,6 1000
WcIuCreateDate weightMeasureConversion WcIuCreateDate Create Date Date N/A System Generated
WcIuCreateUser weightMeasureConversion WcIuCreateUser Create User String N/A System Generated
WcIuUpdateDate weightMeasureConversion WcIuUpdateDate Update Date Date N/A System Generated
WcVUuid weightMeasureConversion WcVUuid UUID String 64 System Generated
Security
HTTP
Type basic

Basic authentication

Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.description+json
"{\r\n  \"Resources\" : {\r\n    \"weightMeasureConversion\" : {\r\n      \"discrColumnType\" : false,\r\n      \"attributes\" : [ {\r\n        \"name\" : \"WcWmFromCode\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : true,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 2\r\n      }, {\r\n        \"name\" : \"WcWmFromName\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 10\r\n      }, {\r\n        \"name\" : \"WcWmToCode\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : true,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 2\r\n      }, {\r\n        \"name\" : \"WcWmToName\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 10\r\n      }, {\r\n        \"name\" : \"WcConvNum\",\r\n        \"type\" : \"number\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 12,\r\n        \"scale\" : 6\r\n      }, {\r\n        \"name\" : \"WcVUuid\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 64\r\n      }, {\r\n        \"name\" : \"WcIuCreateDate\",\r\n        \"type\" : \"datetime\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\"\r\n      }, {\r\n        \"name\" : \"WcIuCreateUser\",\r\n        \"type\" : \"string\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\",\r\n        \"precision\" : 30\r\n      }, {\r\n        \"name\" : \"WcIuUpdateDate\",\r\n        \"type\" : \"datetime\",\r\n        \"updatable\" : true,\r\n        \"mandatory\" : false,\r\n        \"queryable\" : true,\r\n        \"allowChanges\" : \"always\"\r\n      } ],\r\n      \"collection\" : {\r\n        \"rangeSize\" : 25,\r\n        \"finders\" : [ {\r\n          \"name\" : \"PrimaryKey\",\r\n          \"attributes\" : [ {\r\n            \"name\" : \"WcVUuid\",\r\n            \"type\" : \"string\",\r\n            \"updatable\" : true,\r\n            \"mandatory\" : false,\r\n            \"queryable\" : true,\r\n            \"allowChanges\" : \"always\",\r\n            \"precision\" : 64\r\n          } ]\r\n        } ],\r\n        \"links\" : [ {\r\n          \"rel\" : \"self\",\r\n          \"href\" : \"http://127.0.0.1:7101/sys-rest-api/rest/1/weightMeasureConversion\",\r\n          \"name\" : \"self\",\r\n          \"kind\" : \"collection\"\r\n        } ],\r\n        \"actions\" : [ {\r\n          \"name\" : \"get\",\r\n          \"method\" : \"GET\",\r\n          \"responseType\" : [ \"application/vnd.oracle.adf.resourcecollection+json\", \"application/json\" ]\r\n        }, {\r\n          \"name\" : \"create\",\r\n          \"method\" : \"POST\",\r\n          \"requestType\" : [ \"application/vnd.oracle.adf.resourceitem+json\", \"application/json\" ],\r\n          \"responseType\" : [ \"application/vnd.oracle.adf.resourceitem+json\", \"application/json\" ]\r\n        } ]\r\n      },\r\n      \"item\" : {\r\n        \"links\" : [ {\r\n          \"rel\" : \"self\",\r\n          \"href\" : \"http://127.0.0.1:7101/sys-rest-api/rest/1/weightMeasureConversion/{id}\",\r\n          \"name\" : \"self\",\r\n          \"kind\" : \"item\"\r\n        }, {\r\n          \"rel\" : \"canonical\",\r\n          \"href\" : \"http://127.0.0.1:7101/sys-rest-api/rest/1/weightMeasureConversion/{id}\",\r\n          \"name\" : \"canonical\",\r\n          \"kind\" : \"item\"\r\n        } ],\r\n        \"actions\" : [ {\r\n          \"name\" : \"get\",\r\n          \"method\" : \"GET\",\r\n          \"responseType\" : [ \"application/vnd.oracle.adf.resourceitem+json\", \"application/json\" ]\r\n        } ]\r\n      },\r\n      \"links\" : [ {\r\n        \"rel\" : \"self\",\r\n        \"href\" : \"http://127.0.0.1:7101/sys-rest-api/rest/1/weightMeasureConversion/describe\",\r\n        \"name\" : \"self\",\r\n        \"kind\" : \"describe\"\r\n      }, {\r\n        \"rel\" : \"canonical\",\r\n        \"href\" : \"http://127.0.0.1:7101/sys-rest-api/rest/1/weightMeasureConversion/describe\",\r\n        \"name\" : \"canonical\",\r\n        \"kind\" : \"describe\"\r\n      } ]\r\n    }\r\n  }\r\n}"
string
Copyright © 2024 CMiC All Rights Reserved