BLbluestaq
Supporting Data

GET /udl/organization/{id}

Changed on

Service operation to get a single Organization by its unique ID passed as a path parameter.

Request

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

Path parameters

idstring required

The ID of the Organization to retrieve.

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.

namestring required

Organization name.

typestring required

Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC).

categorystring

Subtype or category of the organization (e.g. Private company, stock market quoted company, subsidiary, goverment department/agency, etc).

externalIdstring

Optional externally provided identifier for this row.

descriptionstring

Organization description.

countryCodestring

Country of the physical location of the organization. This value is typically the ISO 3166 Alpha-2 two-character country code. However, it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

nationalitystring

Country of registration or ownership of the organization. This value is typically the ISO 3166 Alpha-2 two-character country code, however it can also represent various consortiums that do not appear in the ISO document. The code must correspond to an existing country in the UDL’s country API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code, or alternate code values that exist for the specified country code.

activeboolean

Boolean indicating if this organization is currently active.

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.

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.

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.

origNetworkstring

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

Example response

{
  "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_86 removed and replaced with

    • info

      the endpoint scheme security BasicAuth was removed from the API

Some revisions have not been checked yet.