BLbluestaq
Onorbit

POST /udl/batterydetails

Changed on

Service operation to take a single BatteryDetails as a POST body and ingest into the database. A Battery record may have multiple details records from several sources. A specific role is required to perform this service operation. Please contact the UDL team for assistance.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/batterydetails
  • Auth
    none declared

Request body

idstring

Unique identifier of the record, auto-generated by the system.

idBatterystring required

Identifier of the parent battery type record.

classificationMarkingstring required

Classification marking of the data in IC/CAPCO Portion-marked format.

technologystring

Type of battery technology (e.g. Ni-Cd, Ni-H2, Li-ion, etc.).

capacitynumber double

Battery capacity in Ah.

dischargeDepthnumber double

Depth of discharge as a percentage/fraction.

modelstring

Battery model number or name.

descriptionstring

Battery description/notes.

manufacturerOrgIdstring

ID of the organization that manufactures the battery.

createdAtstring date-time

Time the row was created in the database, auto-populated by the system.

createdBystring

Application user who created the row in the database, auto-populated by the system.

sourcestring required

Source of the data.

originstring

Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin.

origNetworkstring

The originating source network on which this record was created, auto-populated by the system.

dataMode'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE' required

Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data:

REAL: Data collected or produced that pertains to real-world objects, events, and analysis.

TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics.

EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data.

SIMULATED: Synthetic data generated by a model to mimic real-world datasets.

tagsstring[]

Optional array of provider/source specific tags for this data, where each element is no longer than 32 characters, used for implementing data owner conditional access controls to restrict access to the data. Should be left null by data providers unless conditional access controls are coordinated with the UDL team.

Example request

{
  "id": "BATTERYDETAILS-ID",
  "idBattery": "BATTERY-ID",
  "classificationMarking": "U",
  "technology": "Ni-Cd",
  "capacity": 10.1,
  "dischargeDepth": 0.2,
  "model": "11212",
  "description": "example notes",
  "manufacturerOrgId": "MANUFACTURERORG-ID",
  "createdAt": "2018-01-01T16:00:00.123Z",
  "createdBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST",
  "tags": [
    "PROVIDER_TAG1",
    "PROVIDER_TAG2"
  ]
}

Response

Success

Changes

  • 75f764c843a9Revision changes
    • info

      api operation id create_17 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.