Ingestions - Create

Servicio:

Planetary Computer

Versión de la API:

2025-04-30-preview

Crear una nueva ingesta

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/inma/collections/{collectionId}/ingestions?api-version=2025-04-30-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
collectionId	path	True	string maxLength: 500 pattern: .*	Id. de colección de catálogos
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
importType	True	IngestionType	Tipo de ingesta
displayName		string	Nombre de ingesta
keepOriginalAssets		boolean	Conservar los recursos de origen originales
skipExistingItems		boolean	Omitir el procesamiento de artículos existentes en el catálogo
sourceCatalogUrl		string (uri)	URL del catálogo de origen. *Necesario para el tipo de ingesta StaticCatalog

Respuestas

Nombre	Tipo	Description
201 Created	Ingestions.IngestionDefinition	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado. Encabezados location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
https://geocatalog.spatio.azure.com/.default

Ejemplos

Ingestions_Create

Solicitud de ejemplo

HTTP

POST https://contoso-catalog.gwhqfdeddydpareu.uksouth.geocatalog.spatio.azure.com/inma/collections/collectionId/ingestions?api-version=2025-04-30-preview

{
  "importType": "StaticCatalog",
  "sourceCatalogUrl": "https://sample.blob.core.windows.net/sample.json",
  "skipExistingItems": false,
  "keepOriginalAssets": false
}

Respuesta de muestra

status code:

201

{
  "id": "e1b1b8aa-0b32-4b0a-a25c-d0f806a9133a",
  "creationTime": "2024-10-09T08:37:48.1509869Z",
  "importType": "StaticCatalog",
  "sourceCatalogUrl": "https://sample.blob.core.windows.net/sample.json",
  "skipExistingItems": false,
  "keepOriginalAssets": false,
  "status": "Ready"
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Ingestions.IngestionDefinition	Definición de ingesta de catálogo geográfico de Spatio
Ingestions.IngestionDefinitionCreation	Modelo de creación de ingesta de catálogo geográfico de Spatio
IngestionStatus	Estado de ingesta
IngestionType	Tipo de ingesta

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Una representación en lenguaje natural del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

Ingestions.IngestionDefinition

Object

Definición de ingesta de catálogo geográfico de Spatio

Nombre	Tipo	Description
creationTime	string (date-time)	Tiempo de creación de la ingesta
displayName	string	Nombre de ingesta
id	string (uuid)	Id. de ingesta
importType	IngestionType	Tipo de ingesta
keepOriginalAssets	boolean	Conservar los recursos de origen originales
skipExistingItems	boolean	Omitir el procesamiento de artículos existentes en el catálogo
sourceCatalogUrl	string (uri)	URL del catálogo de origen. *Necesario para el tipo de ingesta StaticCatalog
status	IngestionStatus	Estado de ingesta

Ingestions.IngestionDefinitionCreation

Object

Modelo de creación de ingesta de catálogo geográfico de Spatio

Nombre	Tipo	Description
displayName	string	Nombre de ingesta
importType	IngestionType	Tipo de ingesta
keepOriginalAssets	boolean	Conservar los recursos de origen originales
skipExistingItems	boolean	Omitir el procesamiento de artículos existentes en el catálogo
sourceCatalogUrl	string (uri)	URL del catálogo de origen. *Necesario para el tipo de ingesta StaticCatalog

IngestionStatus

Enumeración

Estado de ingesta

Valor	Description
Deleting	La ingesta se está eliminando en segundo plano
Ready	Ingesta aceptada y lista para ejecutarse

IngestionType

Enumeración

Tipo de ingesta

Valor	Description
StaticCatalog	Catálogo estático de STAC