The sdx-core-ownership system API for Aircraft ownership object API documentation version 1.0

Request access

This is a core API which will consume Foundry API for Aircraft ownership Ontology object

/aircraft-ownership

get post

get

Get a list of aircraft ownership from a specific airline, this endpoint also support search filter with any properties of aircraft ownership ontology columns like (skywise_aircraft_id, operator_code_iata, operator_code_icao, operator_name,...) Example: GET request /aircraft-ownership?skywise_aircraft_id=A320-1234

post

Search a list of scheduled task with post search request.

Get a list of aircraft ownership from a specific airline, this endpoint also support search filter with any properties of aircraft ownership ontology columns like (skywise_aircraft_id, operator_code_iata, operator_code_icao, operator_name,...) Example: GET request /aircraft-ownership?skywise_aircraft_id=A320-1234

URI Parameters

  • ICAO: required(string)

    Airline ICAO code.

    Example:

    AIB

Headers

  • Authorization: required(string)

    Foundry Multipass token allowing to retrieved authorized data from Foundry.

    Example:

    Bearer <jwt>
  • client_id: required(string)

    Enforcement policy is put in place to restrict access to protected resource by allowing requests only from registered client applications. Client id is the identifier of the app, generated from Skywise Developer Portal.

    Example:

    enfjjwdweewo3123jcis382f
  • client_secret: required(string)

    Enforcement policy is put in place to restrict access to protected resource by allowing requests only from registered client applications. Client secret is the "password" of the app, generated at the same time as the client id, from Skywise Developer Portal

    Example:

    fwfjowpeufu83fufu2f83f238r32r

Query Parameters

  • operator: (one of and, or, not - default: and)

    The operator to be applied to a ObjectSearchFilter, which are "or", "and", "not" or another

    Example:

    or
  • orderBy: (string - pattern: ^\w+,(desc|asc)?$)

    Example:

    aircraft_type,asc
  • pagingToken: (string)

    The page token to get the records from next page.

    Example:

    v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10
  • pageSize: (integer - default: 1000 - maximum: 5000)

    The totals of records that could be returned per request.

    Example:

    1000

HTTP status code 200

Headers

  • x-pagination-current-page: required(integer)
  • x-pagination-last-page: required(integer)

Body

Media type: application/json

Type: object

Properties
  • title: required(string)
  • properties: required(object)
    • skywise_aircraft_id: (string)

      Example:

      A319-1234
    • aircraft_registration: (string)

      Example:

      AA-B1234
    • operator_code_iata: (string)

      Example:

      NH
    • operator_code_icao: (string)

      Example:

      ABC
    • operator_name: (string)

      Example:

      All Nippon Airways
    • owner: (string)
    • financier: (string)

      Example:

      Lufthansa Technik Philippines SD-1234
    • flight_cycles_at_delivery: (number)

      Example:

      34
    • flight_hours_at_delivery: (string)

      Example:

      70.4
    • planned_delivery_time: (string)
    • estimated_delivery_time: (string)
    • delivery_time: (string)
    • delivery_airport_name: (string)
    • delivery_airport_iata: (string)
    • delivery_airport_icao: (string)
    • delivery_to_current_operator_time: (string)
    • row_level_policy_msn_id: (string)

      Example:

      N03913
  • primaryKey: required(object)
    • skywise_ownership_id: required(string)

Example:

{
  "title": "Aircraft Ownership",
  "properties": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018",
    "skywise_aircraft_id": "A319-1234",
    "aircraft_registration": "AA-B1234",
    "operator_code_iata": "AB",
    "operator_code_icao": "AIB",
    "operator_name": "Airbus",
    "owner": "Lufthansa Technik Philippines",
    "financier": "Lufthansa Technik Philippines SD-1234",
    "flight_cycles_at_delivery": 34,
    "flight_hours_at_delivery": "70.5",
    "planned_delivery_time": "today",
    "estimated_delivery_time": "now",
    "delivery_time": "now",
    "delivery_airport_name": "Sa Carneiro",
    "delivery_airport_iata": "IATA",
    "delivery_airport_icao": "ICAO",
    "delivery_to_current_operator_time": "now",
    "row_level_policy_msn_id": "N03913"
    },
  "primaryKey": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018"
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 401

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 404

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 405

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 406

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 409

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 415

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 500

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

HTTP status code 502

Body

Media type: application/json

Type: object

Properties
  • errorCode: required(string)
  • errorDateTime: required(string)
  • errorMessage: required(string)
  • errorDescription: required(string)

Search a list of scheduled task with post search request.

URI Parameters

  • ICAO: required(string)

    Airline ICAO code.

    Example:

    AIB

Headers

  • Authorization: required(string)

    Foundry Multipass token allowing to retrieved authorized data from Foundry.

    Example:

    Bearer <jwt>
  • client_id: required(string)

    Enforcement policy is put in place to restrict access to protected resource by allowing requests only from registered client applications. Client id is the identifier of the app, generated from Skywise Developer Portal.

    Example:

    enfjjwdweewo3123jcis382f
  • client_secret: required(string)

    Enforcement policy is put in place to restrict access to protected resource by allowing requests only from registered client applications. Client secret is the "password" of the app, generated at the same time as the client id, from Skywise Developer Portal

    Example:

    fwfjowpeufu83fufu2f83f238r32r

Query Parameters

  • pagingToken: (string)

    The page token to get the records from next page.

    Example:

    v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10
  • pageSize: (integer - default: 1000 - maximum: 5000)

    The totals of records that could be returned per request.

    Example:

    1000

Body

Media type: application/json

Type: object

Example:

{
  "filter": {
    "queryString": {
      "queryString": "A320",
      "field": "aircraft_type"
    },
    "type": "queryString"
  },
  "aggregations": {},
  "highlight": {}
}

HTTP status code 200

Headers

  • x-pagination-current-page: required(integer)
  • x-pagination-last-page: required(integer)

Body

Media type: application/json

Type: any

Example:

{
  "title": "Aircraft Ownership",
  "properties": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018",
    "skywise_aircraft_id": "A319-1234",
    "aircraft_registration": "AA-B1234",
    "operator_code_iata": "AB",
    "operator_code_icao": "AIB",
    "operator_name": "Airbus",
    "owner": "Lufthansa Technik Philippines",
    "financier": "Lufthansa Technik Philippines SD-1234",
    "flight_cycles_at_delivery": 34,
    "flight_hours_at_delivery": "70.5",
    "planned_delivery_time": "today",
    "estimated_delivery_time": "now",
    "delivery_time": "now",
    "delivery_airport_name": "Sa Carneiro",
    "delivery_airport_iata": "IATA",
    "delivery_airport_icao": "ICAO",
    "delivery_to_current_operator_time": "now",
    "row_level_policy_msn_id": "N03913"
    },
  "primaryKey": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018"
  }
}

get post

get

Get a list of aircraft ownership from a specific airline, this endpoint also support search filter with any properties of aircraft ownership ontology columns like (skywise_aircraft_id, operator_code_iata, operator_code_icao, operator_name,...) Example: GET request /aircraft-ownership?skywise_aircraft_id=A320-1234

post

Search a list of scheduled task with post search request.

Get a list of aircraft ownership from a specific airline, this endpoint also support search filter with any properties of aircraft ownership ontology columns like (skywise_aircraft_id, operator_code_iata, operator_code_icao, operator_name,...) Example: GET request /aircraft-ownership?skywise_aircraft_id=A320-1234

URI Parameters

  • ICAO: required(string)

    Airline ICAO code.

    Example:

    AIB

Query Parameters

  • operator: (one of and, or, not - default: and)

    The operator to be applied to a ObjectSearchFilter, which are "or", "and", "not" or another

    Example:

    or
  • orderBy: (string - pattern: ^\w+,(desc|asc)?$)

    Example:

    aircraft_type,asc

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "title": "Aircraft Ownership",
  "properties": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018",
    "skywise_aircraft_id": "A319-1234",
    "aircraft_registration": "AA-B1234",
    "operator_code_iata": "AB",
    "operator_code_icao": "AIB",
    "operator_name": "Airbus",
    "owner": "Lufthansa Technik Philippines",
    "financier": "Lufthansa Technik Philippines SD-1234",
    "flight_cycles_at_delivery": 34,
    "flight_hours_at_delivery": "70.5",
    "planned_delivery_time": "today",
    "estimated_delivery_time": "now",
    "delivery_time": "now",
    "delivery_airport_name": "Sa Carneiro",
    "delivery_airport_iata": "IATA",
    "delivery_airport_icao": "ICAO",
    "delivery_to_current_operator_time": "now",
    "row_level_policy_msn_id": "N03913"
    },
  "primaryKey": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018"
  }
}

Search a list of scheduled task with post search request.

URI Parameters

  • ICAO: required(string)

    Airline ICAO code.

    Example:

    AIB

Query Parameters

  • pagingToken: (string)

    The page token to get the records from next page.

    Example:

    v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10
  • pageSize: (integer - default: 1000 - maximum: 5000)

    The totals of records that could be returned per request.

    Example:

    1000

Body

Media type: application/json

Type: object

Example:

{
  "filter": {
    "queryString": {
      "queryString": "A320",
      "field": "aircraft_type"
    },
    "type": "queryString"
  },
  "aggregations": {},
  "highlight": {}
}

HTTP status code 200

Headers

  • x-pagination-current-page: required(integer)
  • x-pagination-last-page: required(integer)

Body

Media type: application/json

Type: any

Example:

{
  "title": "Aircraft Ownership",
  "properties": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018",
    "skywise_aircraft_id": "A319-1234",
    "aircraft_registration": "AA-B1234",
    "operator_code_iata": "AB",
    "operator_code_icao": "AIB",
    "operator_name": "Airbus",
    "owner": "Lufthansa Technik Philippines",
    "financier": "Lufthansa Technik Philippines SD-1234",
    "flight_cycles_at_delivery": 34,
    "flight_hours_at_delivery": "70.5",
    "planned_delivery_time": "today",
    "estimated_delivery_time": "now",
    "delivery_time": "now",
    "delivery_airport_name": "Sa Carneiro",
    "delivery_airport_iata": "IATA",
    "delivery_airport_icao": "ICAO",
    "delivery_to_current_operator_time": "now",
    "row_level_policy_msn_id": "N03913"
    },
  "primaryKey": {
    "skywise_ownership_id": "AIRBUS-PALANTAIR-A319-1234-20181018"
  }
}