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.

Acquisitions

List Acquisitions

To list Acquisitions for the current instrument.

query Parameters

page	integer (Page) Default: 1
per_page	integer (Per Page) Default: 20
order_by	string (Order By) Default: "end_datetime"
order_direction	string (Order Direction) Default: "desc"

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",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"end_datetime": "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",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"session_order": 0
}
]

Get Acquisition

To get an Acquisition by its 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",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"end_datetime": "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",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"session_order": 0
}

Post Acquisition

To create or update an Acquisition with provided metadata. Reset existing assets state if any.

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
}

Put Acquisition

To update an Acquisition with provided metadata and run associated processing if all assets are uploaded.

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

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",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"end_datetime": "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",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"session_order": 0
}

Patch Acquisition

To update an Acquisition with provided metadata with no follow-up action.

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

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",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"end_datetime": "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",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"session_order": 0
}

Get Acquisition Executions

To get Processing Execution previews associated with a specific Acquisition.

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",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"timestamp_finished": "2019-08-24T14:15:22Z",
"state": "string",
"sign_assets": false,
"sign_state": "string",
"public_message": "string"
}
]

Acquisition Assets

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)
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"
}

Put Asset

To update Asset record to re-indicate that the asset has been uploaded to S3 and is ready to be processed by the processing executions.

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)
required	object (Data)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"key": "string",
"url": "string",
"size": 0,
"state": "prepared",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"data": { },
"verify_hash": "string",
"verify_method": "string",
"verify_state": "ok",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Asset

To update Asset record without any follow-up action

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)
required	object (Data)

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
422

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"content_type": "string",
"key": "string",
"url": "string",
"size": 0,
"state": "prepared",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"data": { },
"verify_hash": "string",
"verify_method": "string",
"verify_state": "ok",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

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": "prepared",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"data": { },
"verify_hash": "string",
"verify_method": "string",
"verify_state": "ok",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

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": "prepared",
"service_account_id": "81f92c7b-60ae-411e-bc6f-e2dc93db8886",
"data": { },
"verify_hash": "string",
"verify_method": "string",
"verify_state": "ok",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]

Custom Ingest [experimental]

Post Custom Ingest

To create Acquisitions using a custom ingest schema along with the special content-type, which only the provider knows.

path Parameters

custom_ingest_id

required

string <uuid> (Custom Ingest Id)

header Parameters

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

Request Body schema: application/json
required

data

required

any (Data)

Responses

Request samples

Payload

Content type

application/json

{"data": null
}

Response samples

201
422

Content type

application/json

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

Ingestion API (0.1.0)

Acquisitions

List Acquisitions

query Parameters

Responses

Response samples

Get Acquisition

path Parameters

Responses

Response samples

Post Acquisition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Put Acquisition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Acquisition

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Acquisition Executions

path Parameters

Responses

Response samples

Acquisition Assets

Post Asset

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Put Asset

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch Asset

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get Asset By Id

path Parameters

Responses

Response samples

Get All Assets

path Parameters

query Parameters

Responses

Response samples

Custom Ingest [experimental]

Post Custom Ingest

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

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required