Jump to

• Request
• Response
• Examples

Get an asset status

get

/services/rest/connect/v1.4/assetStatuses/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the asset status.

Back to Top

Response

Default Response

Body ()

Root Schema : assetStatuses

Type: object

The status of the assets, namely product and services that are registered and tracked in Oracle B2C Service. The default asset statuses are active, retired, and unregistered.

Show Source

• createdTime: string
  The date and time when the asset status was created. This attribute is read-only.
• displayOrder: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The display position relative to other asset statuses.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the asset status.
• lookupName: string
  Maximum Length: 255

  The name used to look up the asset status.
• name: string
  Maximum Length: 80

  The name of the asset status in the language of the current interface.
• names: object assetStatuses-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• statusType: object namedIDs-assetStatuses-statusType
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• updatedTime: string
  The date and time when the asset status was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The status of the assets, namely product and services that are registered and tracked in Oracle B2C Service. The default asset statuses are active, retired, and unregistered.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the asset status was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the asset status in the language of the current interface.",
            "maxLength":"80"
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the asset status.",
            "maxLength":"255"
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/assetStatuses-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the asset status was created. This attribute is read-only."
        },
        "statusType":{
            "type":"object",
            "description":"The type associated with the status.",
            "$ref":"#/definitions/namedIDs-assetStatuses-statusType"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the asset status.",
            "maximum":"9223372036854776000"
        },
        "displayOrder":{
            "minimum":"1",
            "type":"integer",
            "description":"The display position relative to other asset statuses.",
            "maximum":"2147483647"
        }
    }
}

Nested Schema : assetStatuses-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText: string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language: object namedIDs-assetStatuses-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":"80"
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-assetStatuses-names-language"
        }
    }
}

Nested Schema : namedIDs-assetStatuses-statusType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : namedIDs-assetStatuses-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve data for an asset status object:

https://your_site_interface/services/rest/connect/version/assetStatuses/asset_status_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/assetStatuses/26

Response body example

{
  "id": 26,
  "lookupName": "Active",
  "displayOrder": 1,
  "name": "Active",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.comservices/rest/connect/v1.4/assetStatuses/26/names"
      }
    ]
  },
  "statusType": {
    "id": 19,
    "lookupName": "Active"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.comservices/rest/connect/v1.4/assetStatuses/26"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.comservices/rest/connect/v1.4/assetStatuses/26"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.comservices/rest/connect/v1.4/metadata-catalog/assetStatuses",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top