Jump to

• Request
• Response
• Examples

Get Asset Metadata

get

/rest/v19/assets/metadata

This resource retrieves metadata describing attributes available for the Assets resource.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AttributeMetadataBean

Type: object

Show Source

• custom: boolean()
  Title: Custom

  Indicates if this field is a custom filed.
• dataType: string()
  Title: Data Type

  API-consumer friendly type for this field.
• description: string()
  Title: Description

  Explanatory text about the purpose or contents of the field.
• displayName: string()
  Title: Display Name

  User-friendly or translated label for UI or docs.
• displayType: string()
  Title: Display Type

  User display type for this field.
• indexed: boolean()
  Title: Indexed

  Indicates if this field is indexed in the database (impacts search performance).
• keyword: boolean()
  Title: Keyword

  Indicates if this field participates in global keyword search/filtering.
• name: string()
  Title: Name

  English-friendly field name (may be same as displayName).
• readOnly: boolean()
  Title: ReadOnly

  True if this field is not modifiable via write operations (POST, PUT, PATCH).
• searchable: boolean()
  Title: Searchable

  Indicates if this field can be queried via standard filter/search mechanism.
• sortable: boolean()
  Title: Sortable

  Indicates if result sets can be sorted on this field.
• variableName: string()
  Title: Variable Name

  The variable or field name as used in JSON or on the backing resource object.

{
    "properties":{
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable or field name as used in JSON or on the backing resource object.",
            "title":"Variable Name"
        },
        "displayName":{
            "type":"string",
            "format":"",
            "description":"User-friendly or translated label for UI or docs.",
            "title":"Display Name"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"English-friendly field name (may be same as displayName).",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Explanatory text about the purpose or contents of the field.",
            "title":"Description"
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"API-consumer friendly type for this field.",
            "title":"Data Type"
        },
        "displayType":{
            "type":"string",
            "format":"",
            "description":"User display type for this field.",
            "title":"Display Type"
        },
        "searchable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this field can be queried via standard filter/search mechanism.",
            "title":"Searchable"
        },
        "sortable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if result sets can be sorted on this field.",
            "title":"Sortable"
        },
        "indexed":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this field is indexed in the database (impacts search performance).",
            "title":"Indexed"
        },
        "keyword":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this field participates in global keyword search/filtering.",
            "title":"Keyword"
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"True if this field is not modifiable via write operations (POST, PUT, PATCH).",
            "title":"ReadOnly"
        },
        "custom":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if this field is a custom filed.",
            "title":"Custom"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve metadata describing attributes available for the Assets resource by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET  -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/assets/metadata

Response Body Sample

[{
    "variableName": "assetKey",
    "displayName": "Asset Key",
    "name": "Asset Key",
    "description": "Unique key identifier for the asset.",
    "dataType": "string",
    "searchable": true,
    "sortable": true,
    "indexed": true,
    "keyword": true,
    "readonly": false
  }, {
    "variableName": "quantity",
    "displayName": "Quantity",
    "name": "Quantity",
    "description": "The number of units for the asset.",
    "dataType": "integer",
    "searchable": true,
    "sortable": true,
    "indexed": false,
    "keyword": false,
    "readonly": false
  }, {
    "variableName": "startDate",
    "displayName": "Start Date",
    "name": "Start Date",
    "description": "The effective start date of the asset.",
    "dataType": "date",
    "searchable": true,
    "sortable": true,
    "indexed": false,
    "keyword": false,
    "readonly": false
  }
]

Back to Top