Ingestion API (0.1.0)

Download OpenAPI specification:Download

World from Space: orbis@worldfrom.space URL: https://worldfrom.space/services/orbis/

Ingestion API facilitates uploading Acquisitions and Assets for image processing. The specification for Ingestion API follows the OpenAPI 3.0 standard. Read more about the ingestion process.

Ingestion

Handle Post Acquisition

To create an Acquisition with provided metadata.

path Parameters

acquisition_id

required

string <uuid> (Acquisition Id)

header Parameters

x-orbis-api-key required	string (X-Orbis-Api-Key)
x-orbis-instrument-id required	string <uuid> (X-Orbis-Instrument-Id)

Request Body schema: application/json
required

required	object (AcquisitionMetadata)
	Bundle Id (string) or Bundle Id (null) (Bundle Id)
	Session Order (integer) or Session Order (null) (Session Order) Default: 0

Responses

Request samples

Payload

Content type

application/json

{"data": {"acquisition_mode": "nominal",
"orbit_number": 34,
"orbit_direction": "ascending",
"start_datetime": "2023-09-07T12:20:27.000Z",
"end_datetime": "2023-09-07T12:20:27.000Z",
"active_pixels_x": 0,
"active_pixels_y": 0,
"bit_depth": 8,
"binning": 1,
"gain": 1,
"offset": 0,
"integration_time": 80,
"tle": "1 51085U 22002DF  23249.71442117  .00008391  00000+0  40279-3 0  9997",
"attitude": {"satellite_position_latlonalt": [0,
0,
0
],
"satellite_position_ecef": [0,
0,
0
],
"satellite_position_eci": [0,
0,
0
],
"quaternion_eci_to_body": [0,
0,
0,
0
],
"quaternion_eci_to_ecef": [0,
0,
0,
0
],
"off_nadir_angle": 4.7,
"flight_velocity_eci": [2645.653,
3315.483,
-6300.754
]
}
},
"bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",
"session_order": 0
}

Response samples

201
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"session_order": 0
}

Handle Post Asset

To start an Asset uploading process for a specific Acquisition.

path Parameters

acquisition_id required	string <uuid> (Acquisition Id)
asset_id required	string <uuid> (Asset Id)

header Parameters

x-orbis-api-key required	string (X-Orbis-Api-Key)
x-orbis-instrument-id required	string <uuid> (X-Orbis-Instrument-Id)

Request Body schema: application/json
required

content_type required	string (ContentType) Enum: "image/jpeg" "image/png" "image/gif" "image/tiff" "application/json" "application/xml"
key required	string (Key)
data required	object (Data)

Responses

Request samples

Payload

Content type

application/json

{"content_type": "image/jpeg",
"key": "string",
"data": { }
}

Response samples

201
422

Content type

application/json

{"upload_url": "string"
}

Handle Post Acquisition Session

To create an Acquisitions using Session.

path Parameters

acquisition_session_id

required

string <uuid> (Acquisition Session Id)

header Parameters

x-orbis-api-key required	string (X-Orbis-Api-Key)
x-orbis-instrument-id required	string <uuid> (X-Orbis-Instrument-Id)

Request Body schema: application/json
required

required

object (Saturnin1SessionMetadata)

Closed required	boolean (Closed)
PacketVersion required	Array of integers (Packetversion)
PlatformID required	integer (Platformid)
InstrumentID required	integer (Instrumentid)
required	object (ImagerInformation)
required	object (ImagerConfiguration)
required	object (SensorConfiguration)
required	Array of objects (Timesync)
required	Array of objects (Imagertelemetry)
required	Array of objects (Scenes)
session_id required	integer (Session Id)

Responses

Request samples

Payload

Content type

application/json

{"data": {"Closed": true,
"PacketVersion": [0
],
"PlatformID": 0,
"InstrumentID": 0,
"ImagerInformation": {"ProductID": 0,
"SerialNumber": 0,
"FirmwareVersion": [0
],
"SoftwareVersion": [0
],
"BaselineNumber": [0
]
},
"ImagerConfiguration": {"FrameInterval": 0,
"ExposureTime": 0,
"BinningFactor": 0,
"ThumbnailFactor": 0
},
"SensorConfiguration": {"ADCRange": 0,
"BottomOffset": 0,
"TopOffset": 0,
"Gain": 0,
"EBlackEnable": 0
},
"TimeSync": [{"ImagerTime": 0,
"TimeFormat": 0,
"PlatformTime": 0
}
],
"ImagerTelemetry": [{"ImagerTime": 0,
"SensorTemperature": 0
}
],
"Scenes": [{"Type": 0,
"Width": 0,
"Height": 0,
"RawBands": [{"Format": 0,
"Encoding": 0,
"LineLength": 0,
"ExposureTimestamp": 0
}
],
"ThumbnailBands": [{"Format": 0,
"Encoding": 0,
"LineLength": 0,
"ExposureTimestamp": 0
}
],
"capture_timestamp": "string",
"aocs": [{"LocalTime": [0
],
"bct_xact_Time_Out_Response": {"Addr": 0,
"Length": 0,
"TaiSeconds": 0,
"JdOfNowWrtTai": 0,
"GpsUpdateCyclePeriod": 0,
"GpsUpdateCycleCount": 0,
"TimeValid": 0,
"UtcToTai": 0,
"crc": 0
},
"bct_xact_Refs_Out_Response": {"Addr": 0,
"Length": 0,
"GpsTimer": 0,
"TimeNow": 0,
"Q_ecef_wrt_eci": [0
],
"Position_wrt_eci": [0
],
"Position_wrt_ecef": [0
],
"Velocity_wrt_eci": [0
],
"Velocity_wrt_ecef": [0
],
"NadirVectorBody": [0
],
"GdNadirVectorBody": [0
],
"ModeledSunVectorBody": [0
],
"MoonVectorBody": [0
],
"MagModelVector_eci": [0
],
"SunPosition_wrt_eci": [0
],
"MoonPosition_wrt_eci": [0
],
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"BetaAngle": 0,
"OrbitMethod": 0,
"Esm_Valid": 0,
"SunEclipseMoonPenumbraFlag": 0,
"SunEclipseMoonUmbraFlag": 0,
"SunAvoidEclipseFlag": 0,
"EarthUmbraFlag": 0,
"EarthPenumbraUmbra": 0,
"RunLowRateTask": 0,
"GpsAutoSyncEnabled": 0,
"GpsValid": 0,
"TimeValid": 0,
"RefsValid": 0,
"crc": 0
},
"bct_xact_AttCmd_Out_Response": {"Addr": 0,
"Length": 0,
"CmdQ_body_wrt_eci": [0
],
"PriRefDir": 0,
"SecRefDir": 0,
"CmdTarget": [0
],
"PriCmdVecBody": [0
],
"SecCmdVecBody": [0
],
"Q_Target_wrt_Ref": [0
],
"CmdBodyRate": [0
],
"CmdBodyAccel": [0
],
"CommandedSun": [0
],
"HRCycleSafeMode": 0,
"RotisserieRate": 0,
"SunPointReason": 0,
"RecommendSunPoint": 0,
"AdcsMode": 0,
"crc": 0
},
"bct_xact_AttDet_Out_Response": {"Addr": 0,
"Length": 0,
"Q_body_wrt_eci": [0
],
"Residual": [0
],
"BodyRate": [0
],
"GyroBiasEst": [0
],
"AttitudeAlg": 0,
"GoodAttRateTimer": 0,
"BadAttTimer": 0,
"BadRateTimer": 0,
"ReinitCount": 0,
"TrackerUsed": 0,
"TrackerPreference": 0,
"TrackerSolMixed": 0,
"Tracker2DataValid": 0,
"Tracker1DataValid": 0,
"ImuDataValid": 0,
"MeasRateValid": 0,
"MeasAttValid": 0,
"AttitudeValid": 0,
"crc": 0
},
"bct_xact_Analogs_Out_Response": {"Addr": 0,
"Length": 0,
"Voltage_2p5": 0,
"Voltage_1p8": 0,
"Voltage_1p2": 0,
"Det_Temp": 0,
"ExtTemp": 0,
"ImuTemp": 0,
"Motor1Temp": 0,
"Motor2Temp": 0,
"Motor3Temp": 0,
"Motor4Temp": 0,
"DigitalBusV": 0,
"MotorBusV": 0,
"RodBusV": 0,
"crc": 0
}
}
]
}
],
"session_id": 0
}
}

Response samples

201
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"session_order": 0
}
]

acquisitions

Handle Get All Acquisitions

query Parameters

limit

integer (Limit)

Default: 20

Responses

Response samples

200
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"instrument_id": "ed4d91c8-6cde-426b-9f6e-169d7d2e7cda",
"timestamp_created": "2019-08-24T14:15:22Z",
"data": {"acquisition_mode": "nominal",
"orbit_number": 34,
"orbit_direction": "ascending",
"start_datetime": "2023-09-07T12:20:27.000Z",
"end_datetime": "2023-09-07T12:20:27.000Z",
"active_pixels_x": 0,
"active_pixels_y": 0,
"bit_depth": 8,
"binning": 1,
"gain": 1,
"offset": 0,
"integration_time": 80,
"tle": "1 51085U 22002DF  23249.71442117  .00008391  00000+0  40279-3 0  9997",
"attitude": {"satellite_position_latlonalt": [0,
0,
0
],
"satellite_position_ecef": [0,
0,
0
],
"satellite_position_eci": [0,
0,
0
],
"quaternion_eci_to_body": [0,
0,
0,
0
],
"quaternion_eci_to_ecef": [0,
0,
0,
0
],
"off_nadir_angle": 4.7,
"flight_velocity_eci": [2645.653,
3315.483,
-6300.754
]
}
},
"bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",
"session_order": 0
}
]

Handle Get Acquisition By Id

path Parameters

acquisition_id

required

string <uuid> (Acquisition Id)

Responses

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"instrument_id": "ed4d91c8-6cde-426b-9f6e-169d7d2e7cda",
"timestamp_created": "2019-08-24T14:15:22Z",
"data": {"acquisition_mode": "nominal",
"orbit_number": 34,
"orbit_direction": "ascending",
"start_datetime": "2023-09-07T12:20:27.000Z",
"end_datetime": "2023-09-07T12:20:27.000Z",
"active_pixels_x": 0,
"active_pixels_y": 0,
"bit_depth": 8,
"binning": 1,
"gain": 1,
"offset": 0,
"integration_time": 80,
"tle": "1 51085U 22002DF  23249.71442117  .00008391  00000+0  40279-3 0  9997",
"attitude": {"satellite_position_latlonalt": [0,
0,
0
],
"satellite_position_ecef": [0,
0,
0
],
"satellite_position_eci": [0,
0,
0
],
"quaternion_eci_to_body": [0,
0,
0,
0
],
"quaternion_eci_to_ecef": [0,
0,
0,
0
],
"off_nadir_angle": 4.7,
"flight_velocity_eci": [2645.653,
3315.483,
-6300.754
]
}
},
"bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",
"session_order": 0
}

Handle Get Asset By Id

path Parameters

asset_id

required

string <uuid> (Asset Id)

Responses

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"key": "string",
"url": "string",
"size": 0,
"state": "string"
}

Handle Get All Assets

path Parameters

acquisition_id

required

string <uuid> (Acquisition Id)

query Parameters

full_url

boolean (Full Url)

Default: false

Responses

Response samples

200
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"key": "string",
"url": "string",
"size": 0,
"state": "string"
}
]

Handle Get Acquisition Executions

path Parameters

acquisition_id

required

string <uuid> (Acquisition Id)

Responses

Response samples

200
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
"instrument_id": "ed4d91c8-6cde-426b-9f6e-169d7d2e7cda",
"bundle_id": "fc6f5a67-caa1-4339-9c14-a67826143b60",
"config": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"description": "string",
"title_short": "string",
"level": "string",
"trigger_mode": "string",
"trigger_after_collection_id": "string",
"trigger_after_processing_config_id": "6c0b0f59-ecd1-48a8-ba1b-c253100a7572",
"product_collection_id": "string"
},
"timestamp_created": "2019-08-24T14:15:22Z",
"timestamp_finished": "2019-08-24T14:15:22Z",
"state": "string"
}
]

Handle Post Acquisition Session

To create an Acquisitions using Session.

path Parameters

acquisition_session_id

required

string <uuid> (Acquisition Session Id)

header Parameters

x-orbis-api-key required	string (X-Orbis-Api-Key)
x-orbis-instrument-id required	string <uuid> (X-Orbis-Instrument-Id)

Request Body schema: application/json
required

required

object (Saturnin1SessionMetadata)

Closed required	boolean (Closed)
PacketVersion required	Array of integers (Packetversion)
PlatformID required	integer (Platformid)
InstrumentID required	integer (Instrumentid)
required	object (ImagerInformation)
required	object (ImagerConfiguration)
required	object (SensorConfiguration)
required	Array of objects (Timesync)
required	Array of objects (Imagertelemetry)
required	Array of objects (Scenes)
session_id required	integer (Session Id)

Responses

Request samples

Payload

Content type

application/json

{"data": {"Closed": true,
"PacketVersion": [0
],
"PlatformID": 0,
"InstrumentID": 0,
"ImagerInformation": {"ProductID": 0,
"SerialNumber": 0,
"FirmwareVersion": [0
],
"SoftwareVersion": [0
],
"BaselineNumber": [0
]
},
"ImagerConfiguration": {"FrameInterval": 0,
"ExposureTime": 0,
"BinningFactor": 0,
"ThumbnailFactor": 0
},
"SensorConfiguration": {"ADCRange": 0,
"BottomOffset": 0,
"TopOffset": 0,
"Gain": 0,
"EBlackEnable": 0
},
"TimeSync": [{"ImagerTime": 0,
"TimeFormat": 0,
"PlatformTime": 0
}
],
"ImagerTelemetry": [{"ImagerTime": 0,
"SensorTemperature": 0
}
],
"Scenes": [{"Type": 0,
"Width": 0,
"Height": 0,
"RawBands": [{"Format": 0,
"Encoding": 0,
"LineLength": 0,
"ExposureTimestamp": 0
}
],
"ThumbnailBands": [{"Format": 0,
"Encoding": 0,
"LineLength": 0,
"ExposureTimestamp": 0
}
],
"capture_timestamp": "string",
"aocs": [{"LocalTime": [0
],
"bct_xact_Time_Out_Response": {"Addr": 0,
"Length": 0,
"TaiSeconds": 0,
"JdOfNowWrtTai": 0,
"GpsUpdateCyclePeriod": 0,
"GpsUpdateCycleCount": 0,
"TimeValid": 0,
"UtcToTai": 0,
"crc": 0
},
"bct_xact_Refs_Out_Response": {"Addr": 0,
"Length": 0,
"GpsTimer": 0,
"TimeNow": 0,
"Q_ecef_wrt_eci": [0
],
"Position_wrt_eci": [0
],
"Position_wrt_ecef": [0
],
"Velocity_wrt_eci": [0
],
"Velocity_wrt_ecef": [0
],
"NadirVectorBody": [0
],
"GdNadirVectorBody": [0
],
"ModeledSunVectorBody": [0
],
"MoonVectorBody": [0
],
"MagModelVector_eci": [0
],
"SunPosition_wrt_eci": [0
],
"MoonPosition_wrt_eci": [0
],
"Latitude": 0,
"Longitude": 0,
"Altitude": 0,
"BetaAngle": 0,
"OrbitMethod": 0,
"Esm_Valid": 0,
"SunEclipseMoonPenumbraFlag": 0,
"SunEclipseMoonUmbraFlag": 0,
"SunAvoidEclipseFlag": 0,
"EarthUmbraFlag": 0,
"EarthPenumbraUmbra": 0,
"RunLowRateTask": 0,
"GpsAutoSyncEnabled": 0,
"GpsValid": 0,
"TimeValid": 0,
"RefsValid": 0,
"crc": 0
},
"bct_xact_AttCmd_Out_Response": {"Addr": 0,
"Length": 0,
"CmdQ_body_wrt_eci": [0
],
"PriRefDir": 0,
"SecRefDir": 0,
"CmdTarget": [0
],
"PriCmdVecBody": [0
],
"SecCmdVecBody": [0
],
"Q_Target_wrt_Ref": [0
],
"CmdBodyRate": [0
],
"CmdBodyAccel": [0
],
"CommandedSun": [0
],
"HRCycleSafeMode": 0,
"RotisserieRate": 0,
"SunPointReason": 0,
"RecommendSunPoint": 0,
"AdcsMode": 0,
"crc": 0
},
"bct_xact_AttDet_Out_Response": {"Addr": 0,
"Length": 0,
"Q_body_wrt_eci": [0
],
"Residual": [0
],
"BodyRate": [0
],
"GyroBiasEst": [0
],
"AttitudeAlg": 0,
"GoodAttRateTimer": 0,
"BadAttTimer": 0,
"BadRateTimer": 0,
"ReinitCount": 0,
"TrackerUsed": 0,
"TrackerPreference": 0,
"TrackerSolMixed": 0,
"Tracker2DataValid": 0,
"Tracker1DataValid": 0,
"ImuDataValid": 0,
"MeasRateValid": 0,
"MeasAttValid": 0,
"AttitudeValid": 0,
"crc": 0
},
"bct_xact_Analogs_Out_Response": {"Addr": 0,
"Length": 0,
"Voltage_2p5": 0,
"Voltage_1p8": 0,
"Voltage_1p2": 0,
"Det_Temp": 0,
"ExtTemp": 0,
"ImuTemp": 0,
"Motor1Temp": 0,
"Motor2Temp": 0,
"Motor3Temp": 0,
"Motor4Temp": 0,
"DigitalBusV": 0,
"MotorBusV": 0,
"RodBusV": 0,
"crc": 0
}
}
]
}
],
"session_id": 0
}
}

Response samples

201
422

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"session_order": 0
}
]

Ingestion API (0.1.0)

Ingestion

Handle Post Acquisition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Handle Post Asset

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Handle Post Acquisition Session

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

acquisitions

Handle Get All Acquisitions

query Parameters

Responses

Response samples

Handle Get Acquisition By Id

path Parameters

Responses

Response samples

Handle Get Asset By Id

path Parameters

Responses

Response samples

Handle Get All Assets

path Parameters

query Parameters

Responses

Response samples

Handle Get Acquisition Executions

path Parameters

Responses

Response samples

Handle Post Acquisition Session

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required