BLbluestaq
Supporting Data

GET /udl/status/byIdEntity/{idEntity}

Changed on

Service operation to get all statuses related to a particular entity.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/udl/status/byIdEntity/{idEntity}
  • Auth
    none declared

Path parameters

idEntitystring required

The entity id to find the list of statuses for.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

idstring

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

classificationMarkingstring required

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

derivedFromstring

The sources or SCG references from which the classification of this data is derived.

declassificationDatestring date-time

The declassification date of this data, in ISO 8601 UTC format.

declassificationStringstring

Declassification string of this data.

idEntitystring required

Unique identifier of the parent entity.

state'UNKNOWN' | 'DEAD' | 'ACTIVE' | 'RF ACTIVE' | 'STANDBY'

Overall state of the entity, if applicable (e.g. UNKNOWN, DEAD, ACTIVE, RF ACTIVE, STANDBY).

sysCap'FMC' | 'NMC' | 'PMC' | 'UNK'

System capability of the entity, if applicable (e.g. FMC, NMC, PMC, UNK).

opsCap'FMC' | 'NMC' | 'PMC' | 'UNK'

Operation capability of the entity, if applicable (e.g. FMC, NMC, PMC, UNK).

sourcestring required

Source of the data.

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.

notesstring

Comments describing the status creation and or updates to an entity.

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.

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.

Example response

[
  {
    "id": "STATUS-ID",
    "classificationMarking": "U",
    "derivedFrom": "SOME_SOURCE",
    "declassificationDate": "2021-01-01T01:02:02.123Z",
    "declassificationString": "U",
    "idEntity": "ENTITY-ID",
    "state": "ACTIVE",
    "sysCap": "FMC",
    "opsCap": "FMC",
    "source": "Bluestaq",
    "subStatusCollection": [
      {
        "id": "SUBSTATUS-ID",
        "type": "mdCap",
        "classificationMarking": "U",
        "statusId": "REF-STATUS-ID",
        "status": "FMC",
        "notes": "Sample Notes",
        "source": "Bluestaq",
        "origin": "THIRD_PARTY_DATASOURCE",
        "origNetwork": "OPS1",
        "dataMode": "TEST",
        "createdAt": "2018-01-01T16:00:00.123Z",
        "createdBy": "some.user",
        "updatedAt": "2018-01-01T16:00:00.123Z",
        "updatedBy": "some.user"
      }
    ],
    "dataMode": "TEST",
    "notes": "Example Notes",
    "createdAt": "2018-01-01T16:00:00.123Z",
    "createdBy": "some.user",
    "updatedAt": "2018-01-01T16:00:00.123Z",
    "updatedBy": "some.user",
    "origin": "THIRD_PARTY_DATASOURCE",
    "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
    • breaking

      added the new path request parameter idEntity

    • warning

      deleted the query request parameter idEntity

    • info

      api operation id byIdEntity removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.