BLbluestaq
Onorbit

GET /udl/batterydetails/{id}

Changed on

Service operation to get a single BatteryDetails record by its unique ID passed as a path parameter. A Battery record may have multiple details records from several sources.

Request

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

Path parameters

idstring required

The ID of the BatteryDetails to find.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

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.

updatedAtstring date-time

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

updatedBystring

Application user who updated 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 response

{
  "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",
  "updatedAt": "2018-01-01T16:00:00.123Z",
  "updatedBy": "some.user",
  "source": "Bluestaq",
  "origin": "THIRD_PARTY_DATASOURCE",
  "origNetwork": "OPS1",
  "dataMode": "TEST",
  "tags": [
    "PROVIDER_TAG1",
    "PROVIDER_TAG2"
  ],
  "manufacturerOrg": {
    "id": "ORGANIZATION-ID",
    "classificationMarking": "U",
    "name": "some.user",
    "type": "GOVERNMENT",
    "category": "Private company",
    "externalId": "EXTERNAL-ID",
    "description": "Example description",
    "countryCode": "US",
    "nationality": "US",
    "source": "some.user",
    "origin": "some.user",
    "dataMode": "TEST",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "organizationDetails": [
      {
        "id": "ORGANIZATIONDETAILS-ID",
        "idOrganization": "ORGANIZATION-ID",
        "classificationMarking": "U",
        "name": "some.user",
        "email": "some_organization@organization.com",
        "address1": "123 Main Street",
        "address2": "Apt 4B",
        "address3": "Colorado Springs CO, 80903",
        "geoAdminLevel1": "Colorado",
        "geoAdminLevel2": "El Paso County",
        "geoAdminLevel3": "Colorado Springs",
        "postalCode": "80903",
        "description": "Example description",
        "formerOrgId": "FORMERORG-ID",
        "parentOrgId": "PARENTORG-ID",
        "financialYearEndDate": "2021-01-01T01:01:01.123Z",
        "revenue": 123.4,
        "profit": 123.4,
        "ebitda": 123.4,
        "ftes": 123,
        "broker": "some.user",
        "ceo": "some.user",
        "cfo": "some.user",
        "cto": "some.user",
        "riskManager": "some.user",
        "massRanking": 123,
        "revenueRanking": 123,
        "financialNotes": "Example notes",
        "servicesNotes": "Example notes",
        "fleetPlanNotes": "Example notes",
        "source": "some.user",
        "origin": "some.user",
        "dataMode": "TEST",
        "tags": [
          "PROVIDER_TAG1",
          "PROVIDER_TAG2"
        ],
        "createdAt": "2018-01-01T16:00:00.123Z",
        "createdBy": "some.user",
        "updatedAt": "2018-01-01T16:00:00.123Z",
        "updatedBy": "some.user",
        "origNetwork": "OPS1"
      }
    ],
    "origNetwork": "OPS1"
  }
}

Changes

  • 4e1cbc17e814Revision changes
    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

  • 75f764c843a9Revision changes
    • info

      api operation id find_18 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

    • info

      the response optional property became not read-only for the status

Some revisions have not been checked yet.