The sdx-core-damage system API for Damage ontology object API documentation

/damages

/damages/{ICAO} get post

get

Get a list of damage from a specific airline. This endpoint also support search filter with any properties of damage ontology columns like (skywise_scheduled_task_id, skywise_aircraft_id, skywise_logbook_defect_id,..).

post

Search a list of damages object with search request.

Request
Response

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".
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

totalResults: required(number)
results: required(array of typ.objTyp.Damage)
Items: Damage
- title: required(string)
- properties: required(object)
  - skywise_scheduled_task_id: required(string)
    The Skywise Task ID where this damage was reported
  - skywise_logbook_defect_id: required(string)
    The Skywise Logbook defect ID where this damage was reported
  - skywise_aircraft_id: required(string)
    Skywise ID of the aircraft
    Example:
    A319-1234
  - aircraft_id: required(string)
    Source system ID of the aircraft object.
    Example:
    A320-5000
  - aircraft_registration: required(string)
    Registration of the aircraft.
    Example:
    G-EZRA
  - type_code: required(string)
    This is the type code of damage (abrasion, corrosion, deformation, crack...)
    Example:
    RT
  - type_code_description: required(string)
    This is the type of damage (abrasion, corrosion, deformation, crack...)
    Example:
    Corrosion
  - length_millimeters: required(number)
    The measurement of the damaged object or location along its greatest dimension.
  - width_millimeters: required(number)
    The measurement of an object taken at right angles to its length. The numerical value of the width of box, carton or other shipping container.
  - depth_millimeters: required(number)
    The distance measured vertically from the surface of the damaged object or location.
  - diameter_millimeters: required(number)
    The diameter measured of the damaged object or location.
  - remaining_thickness_millimeters: required(number)
    The depth of skin, structure or other surface that is still in acceptable condition (for example, unaffected by corrosion)
  - length_inches: required(number)
    The measurement of the damaged object or location along its greatest dimension.
  - width_inches: required(number)
    The measurement of an object taken at right angles to its length. The numerical value of the width of box, carton or other shipping container.
  - depth_inches: required(number)
    The distance measured vertically from the surface of the damaged object or location.
  - diameter_inches: required(number)
    The diameter measured of the damaged object or location.
  - remaining_thickness_inches: required(number)
    The depth of skin, structure or other surface that is still in acceptable condition (for example, unaffected by corrosion)
  - corrosion_level_code: required(number)
    Defines corrosion levels as referenced in CPCP (Corrosion Prevention and Control Program).
    Example:
    1
  - corrosion_type_code: required(string)
    Specifies the type of corrosion found during inspection CA General / Uniform
    Example:
    CC, CE
  - corrosion_type_code_description: required(string)
    Specifies a textual description of the type of corrosion found during inspection.
  - is_cumulative_blend_out: required(boolean)
    Indicates whether or not the subject part has undergone cumulative blend-outs of the corroded area
    Example:
    true
  - is_non_typical_corrosion: required(boolean)
    Indicates whether or not the subject part has undergone a Non-Typical Event.
    Example:
    true
  - is_previous_tps_applied: required(boolean)
    Indicates the previous use of temporary protection compounds.
    Example:
    true
  - current_tps_type: required(string)
    Specifies the type of current temporary corrosion protection system applied.
  - previous_tps_type: required(string)
    Specifies the type of previous temporary corrosion protection system applied.
  - is_previous_tps_visible: required(boolean)
    Indicates whether or not the use of previous temporary protection is detectable (visible) on the unit.
    Example:
    true
  - coordinate_system: required(string)
    Indicates the coordinate system reference used to locate the damage.
    Example:
    Nacelle
  - position_description: required(string)
    Free text which contains either the location description of the damage relative to the airframe or the engine/APU position (1, 2, 3, 4, etc.) etc
  - radial_range_start: required(number)
    This refers to a radial position range start angle for a radial coordinate system.
  - radial_range_end: required(number)
    This refers to a radial position range end angle for a radial coordinate system.
  - horizontal_axis_range_start: required(number)
    This refers to the Buttock Line value or Airframe Y-axis coordinate range start.
  - horizontal_axis_range_end: required(number)
    This refers to the Buttock Line value or Airframe Y-axis coordinate range end.
  - longitudinal_axis_range_start: required(number)
    This refers to Airframe X-axis coordinate range start.
  - longitudinal_axis_range_end: required(number)
    This refers to Airframe X-axis coordinate range end.
  - vertical_axis_range_start: required(number)
    This refers to the Waterline Number or Airframe Z-axis coordinate range start.
  - vertical_axis_range_end: required(number)
    This refers to the Waterline Number or Airframe Z-axis coordinate range end.
  - frame_range_start: required(string)
    The airframe of an aircraft is its mechanical structure.
  - frame_range_end: required(string)
    The airframe of an aircraft is its mechanical structure.
  - rib_range_start: required(string)
    In an aircraft, ribs are forming elements of the structure of a wing, especially in traditional construction.
  - rib_range_end: required(string)
    In an aircraft, ribs are forming elements of the structure of a wing, especially in traditional construction.
  - spar_range_start: required(string)
  - spar_range_end: required(string)
  - stringer_range_start: required(string)
  - stringer_range_end: required(string)
  - airframe_station_range_start: required(string)
    Starting airframe station name identifying the location.
    Example:
    STA26365
  - airframe_station_range_end: required(string)
    Ending airframe station name identifying the location.
    Example:
    STA26365
  - interior_or_exterior: required(string)
    Indicates whether the structural location is inside or outside of the aircraft.xterior | Interior | Both
    Example:
    Exterior
  - zone_codes: required(array of any)
    The zone code of the area where the damage is located. This helps to locate the part if other location information is not provided
    Example:
    [ "430", "440" ]
  - side_position_codes: required(array of any)
    The side position code of the area where the part is located.
    Example:
    [ "LH" ]
  - access_position_codes: required(array of any)
    Example:
    [ "437AL", "447AL", "438AR", "448AR" ]
  - skywise_part_id: required(string)
    This is the Skywise unique ID for the part which is related to the damage.
    Example:
    B40NA1500-04868
  - structural_repair_manual_references: required(array of any)
    SRM references (SRM = Structural Repair Manual)
    Example:
    [ "SRM-22-00-13" ]
  - structural_repair_manual_references_links: required(array of any)
    Links to SRM references (SRM = Structural Repair Manual), corresponding to srm_references
    Example:
    [ "http://example.com/amm_reference" ]
  - repair_approval_sheet_references: required(string)
    Comma separated list of RAS references (RAS = Repair Approval Sheet)
    Example:
    RAS-12-01-10
  - repair_approval_sheet_references_links: required(string)
    Comma separated list of links to RAS references (RAS = Repair Approval Sheet)
    Example:
    http://example.com/amm_reference
  - repair_material_type_description: required(string)
    Free text to describe the type of material used for a repair.
  - other_remarks: required(string)
    Other remarks about the damage
- primaryKey: required(object)
  - skywise_damage_id: required(string)
nextPageToken: required(string)

Example:

{
  "totalResults": 1234,
  "results": [
    {
      "title": "10000001",
      "properties": {
        "skywise_scheduled_task_id": "1324567",
        "skywise_logbook_defect_id": "654321232",
        "skywise_aircraft_id": "A319-1234",
        "aircraft_id": "A320-5000",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000001"
      }
    },
    {
      "title": "10000002",
      "properties": {
        "skywise_scheduled_task_id": "75546324",
        "skywise_logbook_defect_id": "32132145",
        "skywise_aircraft_id": "A319-3213",
        "aircraft_id": "A320-4543",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000002"
      }
    }
  ],
  "nextPageToken": "v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10"
}

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 damages object with search request.

Request
Response

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": {
    "and": [
      {
        "queryString": {
          "queryString": "123456",
          "field": "skywise_scheduled_task_id"
        },
        "type": "queryString"
      },
      {
        "queryString": {
          "queryString": "A320-1234",
          "field": "skywise_aircraft_id"
        },
        "type": "queryString"
      }
    ],
    "type": "and"
  },
  "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:

{
  "totalResults": 1234,
  "results": [
    {
      "title": "10000001",
      "properties": {
        "skywise_scheduled_task_id": "1324567",
        "skywise_logbook_defect_id": "654321232",
        "skywise_aircraft_id": "A319-1234",
        "aircraft_id": "A320-5000",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000001"
      }
    },
    {
      "title": "10000002",
      "properties": {
        "skywise_scheduled_task_id": "75546324",
        "skywise_logbook_defect_id": "32132145",
        "skywise_aircraft_id": "A319-3213",
        "aircraft_id": "A320-4543",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000002"
      }
    }
  ],
  "nextPageToken": "v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10"
}

/damages/{ICAO}/private get post

get

post

Search a list of damages object with search request.

Request
Response

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:

{
  "totalResults": 1234,
  "results": [
    {
      "title": "10000001",
      "properties": {
        "skywise_scheduled_task_id": "1324567",
        "skywise_logbook_defect_id": "654321232",
        "skywise_aircraft_id": "A319-1234",
        "aircraft_id": "A320-5000",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000001"
      }
    },
    {
      "title": "10000002",
      "properties": {
        "skywise_scheduled_task_id": "75546324",
        "skywise_logbook_defect_id": "32132145",
        "skywise_aircraft_id": "A319-3213",
        "aircraft_id": "A320-4543",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000002"
      }
    }
  ],
  "nextPageToken": "v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10"
}

Search a list of damages object with search request.

Request
Response

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": {
    "and": [
      {
        "queryString": {
          "queryString": "123456",
          "field": "skywise_scheduled_task_id"
        },
        "type": "queryString"
      },
      {
        "queryString": {
          "queryString": "A320-1234",
          "field": "skywise_aircraft_id"
        },
        "type": "queryString"
      }
    ],
    "type": "and"
  },
  "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:

{
  "totalResults": 1234,
  "results": [
    {
      "title": "10000001",
      "properties": {
        "skywise_scheduled_task_id": "1324567",
        "skywise_logbook_defect_id": "654321232",
        "skywise_aircraft_id": "A319-1234",
        "aircraft_id": "A320-5000",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000001"
      }
    },
    {
      "title": "10000002",
      "properties": {
        "skywise_scheduled_task_id": "75546324",
        "skywise_logbook_defect_id": "32132145",
        "skywise_aircraft_id": "A319-3213",
        "aircraft_id": "A320-4543",
        "aircraft_registration": "G-EZRA",
        "type_code": "RT",
        "type_code_description": "Corrosion",
        "length_millimeters": 100,
        "width_millimeters": 100,
        "depth_millimeters": 10,
        "diameter_millimeters": 10,
        "remaining_thickness_millimeters": 10,
        "length_inches": 10,
        "width_inches": 10,
        "depth_inches": 10,
        "diameter_inches": 10,
        "remaining_thickness_inches": 10,
        "corrosion_level_code": 1,
        "corrosion_type_code": "CC",
        "corrosion_type_code_description": "null",
        "is_cumulative_blend_out": true,
        "is_non_typical_corrosion": true,
        "is_previous_tps_applied": true,
        "current_tps_type": "null",
        "previous_tps_type": "null",
        "is_previous_tps_visible": true,
        "coordinate_system": "Nacelle",
        "position_description": "null",
        "radial_range_start": 2,
        "radial_range_end": 2,
        "horizontal_axis_range_start": 2,
        "horizontal_axis_range_end": 2,
        "longitudinal_axis_range_start": 2,
        "longitudinal_axis_range_end": 2,
        "vertical_axis_range_start": 2,
        "vertical_axis_range_end": 2,
        "frame_range_start": "null",
        "frame_range_end": "null",
        "rib_range_start": "null",
        "rib_range_end": "null",
        "spar_range_start": "null",
        "spar_range_end": "null",
        "stringer_range_start": "null",
        "stringer_range_end": "null",
        "airframe_station_range_start": "STA26365",
        "airframe_station_range_end": "STA26365",
        "interior_or_exterior": "Exterior",
        "zone_codes": [
          "430",
          "440"
        ],
        "side_position_codes": [
          "LH"
        ],
        "access_position_codes": [
          "437AL",
          "447AL",
          "438AR",
          "448AR"
        ],
        "skywise_part_id": "B40NA1500-04868",
        "structural_repair_manual_references": [
          "SRM-22-00-13"
        ],
        "structural_repair_manual_references_links": [
          "http://example.com/amm_reference"
        ],
        "repair_approval_sheet_references": "RAS-12-01-10",
        "repair_approval_sheet_references_links": "http://example.com/amm_reference",
        "repair_material_type_description": "null",
        "other_remarks": "null"
      },
      "primaryKey": {
        "skywise_damage_id": "10000002"
      }
    }
  ],
  "nextPageToken": "v1.58f64e36-8bcf-48e4-9377-d4ab9c3f5a71.10"
}

The sdx-core-damage system API for Damage ontology object API documentation version 1.0

/damages

/damages/{ICAO} get post

get /damages/{ICAO}

URI Parameters

Headers

Query Parameters

HTTP status code 200

Headers

Body

HTTP status code 400

Body

HTTP status code 401

Body

HTTP status code 404

Body

HTTP status code 405

Body

HTTP status code 406

Body

HTTP status code 409

Body

HTTP status code 415

Body

HTTP status code 500

Body

HTTP status code 502

Body

post /damages/{ICAO}

URI Parameters

Headers

Query Parameters

Body

HTTP status code 200

Headers

Body

/damages/{ICAO}/private get post

get /damages/{ICAO}/private

URI Parameters

Query Parameters

HTTP status code 200

Body

post /damages/{ICAO}/private

URI Parameters

Query Parameters

Body

HTTP status code 200

Headers

Body