Jump to

• Request
• Response

Create Item

post

/rest/apis/meter/devices/items/

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• assetId: string
  Maximum Length: 120

  The device identifier for the Asset ID.

  Example: LP3211
• badgeNumber: string
  Maximum Length: 120

  The device identifier for the Badge Number.

  Example: 32505964
• boStatus: string
  Maximum Length: 12

  Status of the item device

  Example: ACTIVE
• characteristics: object characteristics
• configuration: string
  Maximum Length: 120

  Configuration is the type of configuration

  Example: Badged Item KW
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2020-10-12T22:35:28-07:00
• externalId: string
  Maximum Length: 60

  External identifier for the item device.

  Example: 29256350
• internalNumber: string
  Maximum Length: 120

  The device identifier value for the internal number.

  Example: I-20140306001
• itemId: string
  Maximum Length: 12

  The Device or meter identifier in the source system.

  Example: 881940890969
• itemType: object itemType
• manufacturer: object manufacturer
  The Manufacturer of the device.
• mdmExternalId: string
  Maximum Length: 60

  MDM External ID for the item device.

  Example: 32505964
• model: string
  Maximum Length: 30

  The specific model number of the device provided by the manufacturer.

  Example: ELECTRIC 4
• retirementDateTime: string (date-time)
  Retirement Date/Time

  Example: 2020-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  The device identifier for the Serial Number.

  Example: SV100-60012
• specification: string
  Maximum Length: 120

  Specifications are used to define the manufacturer, model, and other information about the template device.

  Example: BIT_01
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2020-10-13T02:16:42-07:00
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "maxLength":12,
            "description":"The Device or meter identifier in the source system.",
            "example":"881940890969"
        },
        "itemType":{
            "type":"object",
            "properties":{
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type"
                }
            }
        },
        "boStatus":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the item device",
            "example":"ACTIVE"
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Serial Number.",
            "example":"SV100-60012"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Badge Number.",
            "example":"32505964"
        },
        "internalNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier value for the internal number.",
            "example":"I-20140306001"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Asset ID.",
            "example":"LP3211"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External identifier for the item device.",
            "example":"29256350"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"MDM External ID for the item device.",
            "example":"32505964"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Specifications are used to define the manufacturer, model, and other information about the template device.",
            "example":"BIT_01"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Configuration is the type of configuration",
            "example":"Badged Item KW"
        },
        "manufacturer":{
            "type":"object",
            "description":"The Manufacturer of the device.",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Manufacturer of the device.",
                    "example":"GE"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"The specific model number of the device provided by the manufacturer.",
            "example":"ELECTRIC 4"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date/Time",
            "example":"2020-10-13T00:00:00-07:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2020-10-13T02:16:42-07:00"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2020-10-12T22:35:28-07:00"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"5"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Item"
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"5"
                    }
                }
            }
        }
    }
}

Nested Schema : itemType

Type: object

Show Source

• deviceType: string
  Maximum Length: 30

  Device Type

{
    "type":"object",
    "properties":{
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type"
        }
    }
}

Nested Schema : manufacturer

Type: object

The Manufacturer of the device.

Show Source

• manufacturer: string
  Maximum Length: 30

  The Manufacturer of the device.

  Example: GE

{
    "type":"object",
    "description":"The Manufacturer of the device.",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"The Manufacturer of the device.",
            "example":"GE"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• effectiveDate: string (date)
  Effective Date
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Char Value: * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assetId: string
  Maximum Length: 120

  The device identifier for the Asset ID.

  Example: LP3211
• badgeNumber: string
  Maximum Length: 120

  The device identifier for the Badge Number.

  Example: 32505964
• boStatus: string
  Maximum Length: 12

  Status of the item device

  Example: ACTIVE
• characteristics: object characteristics
• configuration: string
  Maximum Length: 120

  Configuration is the type of configuration

  Example: Badged Item KW
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2020-10-12T22:35:28-07:00
• externalId: string
  Maximum Length: 60

  External identifier for the item device.

  Example: 29256350
• internalNumber: string
  Maximum Length: 120

  The device identifier value for the internal number.

  Example: I-20140306001
• itemId: string
  Maximum Length: 12

  The Device or meter identifier in the source system.

  Example: 881940890969
• itemType: object itemType
• manufacturer: object manufacturer
  The Manufacturer of the device.
• mdmExternalId: string
  Maximum Length: 60

  MDM External ID for the item device.

  Example: 32505964
• model: string
  Maximum Length: 30

  The specific model number of the device provided by the manufacturer.

  Example: ELECTRIC 4
• retirementDateTime: string (date-time)
  Retirement Date/Time

  Example: 2020-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  The device identifier for the Serial Number.

  Example: SV100-60012
• specification: string
  Maximum Length: 120

  Specifications are used to define the manufacturer, model, and other information about the template device.

  Example: BIT_01
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2020-10-13T02:16:42-07:00
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "maxLength":12,
            "description":"The Device or meter identifier in the source system.",
            "example":"881940890969"
        },
        "itemType":{
            "type":"object",
            "properties":{
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type"
                }
            }
        },
        "boStatus":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the item device",
            "example":"ACTIVE"
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Serial Number.",
            "example":"SV100-60012"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Badge Number.",
            "example":"32505964"
        },
        "internalNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier value for the internal number.",
            "example":"I-20140306001"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Asset ID.",
            "example":"LP3211"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External identifier for the item device.",
            "example":"29256350"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"MDM External ID for the item device.",
            "example":"32505964"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Specifications are used to define the manufacturer, model, and other information about the template device.",
            "example":"BIT_01"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Configuration is the type of configuration",
            "example":"Badged Item KW"
        },
        "manufacturer":{
            "type":"object",
            "description":"The Manufacturer of the device.",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Manufacturer of the device.",
                    "example":"GE"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"The specific model number of the device provided by the manufacturer.",
            "example":"ELECTRIC 4"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date/Time",
            "example":"2020-10-13T00:00:00-07:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2020-10-13T02:16:42-07:00"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2020-10-12T22:35:28-07:00"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"5"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Item"
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"5"
                    }
                }
            }
        }
    }
}

Nested Schema : itemType

Type: object

Show Source

• deviceType: string
  Maximum Length: 30

  Device Type

{
    "type":"object",
    "properties":{
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type"
        }
    }
}

Nested Schema : manufacturer

Type: object

The Manufacturer of the device.

Show Source

• manufacturer: string
  Maximum Length: 30

  The Manufacturer of the device.

  Example: GE

{
    "type":"object",
    "description":"The Manufacturer of the device.",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"The Manufacturer of the device.",
            "example":"GE"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• effectiveDate: string (date)
  Effective Date
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Char Value: * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1-Item

Type: object

Show Source

• _self: string
  _self
• assetId: string
  Maximum Length: 120

  The device identifier for the Asset ID.

  Example: LP3211
• badgeNumber: string
  Maximum Length: 120

  The device identifier for the Badge Number.

  Example: 32505964
• boStatus: string
  Maximum Length: 12

  Status of the item device

  Example: ACTIVE
• characteristics: object characteristics
• configuration: string
  Maximum Length: 120

  Configuration is the type of configuration

  Example: Badged Item KW
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2020-10-12T22:35:28-07:00
• externalId: string
  Maximum Length: 60

  External identifier for the item device.

  Example: 29256350
• internalNumber: string
  Maximum Length: 120

  The device identifier value for the internal number.

  Example: I-20140306001
• itemId: string
  Maximum Length: 12

  The Device or meter identifier in the source system.

  Example: 881940890969
• itemType: object itemType
• manufacturer: object manufacturer
  The Manufacturer of the device.
• mdmExternalId: string
  Maximum Length: 60

  MDM External ID for the item device.

  Example: 32505964
• model: string
  Maximum Length: 30

  The specific model number of the device provided by the manufacturer.

  Example: ELECTRIC 4
• retirementDateTime: string (date-time)
  Retirement Date/Time

  Example: 2020-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  The device identifier for the Serial Number.

  Example: SV100-60012
• specification: string
  Maximum Length: 120

  Specifications are used to define the manufacturer, model, and other information about the template device.

  Example: BIT_01
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2020-10-13T02:16:42-07:00
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "itemId":{
            "type":"string",
            "maxLength":12,
            "description":"The Device or meter identifier in the source system.",
            "example":"881940890969"
        },
        "itemType":{
            "type":"object",
            "properties":{
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "boStatus":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the item device",
            "example":"ACTIVE"
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Serial Number.",
            "example":"SV100-60012"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Badge Number.",
            "example":"32505964"
        },
        "internalNumber":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier value for the internal number.",
            "example":"I-20140306001"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"The device identifier for the Asset ID.",
            "example":"LP3211"
        },
        "externalId":{
            "type":"string",
            "maxLength":60,
            "description":"External identifier for the item device.",
            "example":"29256350"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":60,
            "description":"MDM External ID for the item device.",
            "example":"32505964"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Specifications are used to define the manufacturer, model, and other information about the template device.",
            "example":"BIT_01"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Configuration is the type of configuration",
            "example":"Badged Item KW"
        },
        "manufacturer":{
            "type":"object",
            "description":"The Manufacturer of the device.",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"The Manufacturer of the device.",
                    "example":"GE"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"The specific model number of the device provided by the manufacturer.",
            "example":"ELECTRIC 4"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date/Time",
            "example":"2020-10-13T00:00:00-07:00"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2020-10-13T02:16:42-07:00"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2020-10-12T22:35:28-07:00"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "maxLength":254,
                                        "description":"Adhoc Characteristic Value"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 2"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 3"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 4"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "maxLength":50,
                                        "description":"Foreign Key Value 5"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"5"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Item"
    }
}

Nested Schema : characteristics

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Adhoc Characteristic Value"
                            },
                            "value2":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 2"
                            },
                            "value3":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 3"
                            },
                            "value4":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 4"
                            },
                            "value5":{
                                "type":"string",
                                "maxLength":50,
                                "description":"Foreign Key Value 5"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"5"
                    }
                }
            }
        }
    }
}

Nested Schema : itemType

Type: object

Show Source

• _link: string
  _link
• deviceType: string
  Maximum Length: 30

  Device Type

{
    "type":"object",
    "properties":{
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : manufacturer

Type: object

The Manufacturer of the device.

Show Source

• _link: string
  _link
• manufacturer: string
  Maximum Length: 30

  The Manufacturer of the device.

  Example: GE

{
    "type":"object",
    "description":"The Manufacturer of the device.",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"The Manufacturer of the device.",
            "example":"GE"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "effectiveDate":{
                "type":"string",
                "format":"date",
                "description":"Effective Date"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Adhoc Characteristic Value"
                    },
                    "value2":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 2"
                    },
                    "value3":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 3"
                    },
                    "value4":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 4"
                    },
                    "value5":{
                        "type":"string",
                        "maxLength":50,
                        "description":"Foreign Key Value 5"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"5"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• characteristicType: object characteristicType
• characteristicValue: object characteristicValue
• effectiveDate: string (date)
  Effective Date
• typeOfCharacteristicValue: string
  Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

  Type of Char Value: * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 5

{
    "type":"object",
    "properties":{
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Type of Char Value:\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "maxLength":254,
                    "description":"Adhoc Characteristic Value"
                },
                "value2":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 2"
                },
                "value3":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 3"
                },
                "value4":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 4"
                },
                "value5":{
                    "type":"string",
                    "maxLength":50,
                    "description":"Foreign Key Value 5"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"5"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

• _link: string
  _link
• characteristicType: string
  Maximum Length: 8

  Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":8,
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

• _link: string
  (_link)
• value: string
  Maximum Length: 254

  Adhoc Characteristic Value
• value2: string
  Maximum Length: 50

  Foreign Key Value 2
• value3: string
  Maximum Length: 50

  Foreign Key Value 3
• value4: string
  Maximum Length: 50

  Foreign Key Value 4
• value5: string
  Maximum Length: 50

  Foreign Key Value 5

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "value2":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 2"
        },
        "value3":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 3"
        },
        "value4":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 4"
        },
        "value5":{
            "type":"string",
            "maxLength":50,
            "description":"Foreign Key Value 5"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top