https://api.nexscope.ai/ai/designRegistrationDetailsEjecutar esta API
Envía una solicitud JSON para ejecutar esta API y recibir los datos de respuesta documentados.
Endpoint
| Método | POST |
| Ruta | https://api.nexscope.ai/ai/designRegistrationDetails |
| Autenticación | Bearer API key |
| Content-Type | application/json |
Parámetros de la solicitud
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
designRegistrationIds | array | opcional | 1–200 identificadores de registro exactos únicos, cada uno de los caracteres recortados 1–128; no incluye primaryIdentifier y jurisdictionIso2. Cantidad mínima de elementos: 1 Cantidad máxima de elementos: 200 |
designRegistrationIds[] | string | obligatorio | 1–200 identificadores de registro exactos únicos, cada uno de los caracteres recortados 1–128; no incluye primaryIdentifier y jurisdictionIso2. Patrón: ^\S(?:[^\r\n]*\S)?$ Longitud mínima: 1 Longitud máxima: 128 |
jurisdictionIso2 | string | opcional | Jurisdicción facultativa de dos letras, sólo con primaryIdentifier; utilizar EM para la UE. Patrón: ^[A-Za-z]{2}$ |
primaryIdentifier | string | opcional | Número primario exacto, 1-128 caracteres recortados; preservar ceros principales. Excluidos designRegistrationIds. Patrón: ^\S(?:[^\r\n]*\S)?$ Longitud mínima: 1 Longitud máxima: 128 |
Opción 1 de una alternativa — requiere designRegistrationIds
Opción 2 de una alternativa — requiere primaryIdentifier
Respuesta de ejemplo
Estructura de respuesta de la plataforma. code 0 indica éxito o aceptación; data contiene el resultado de negocio.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"code": "OK",
"data": {
"items": [
{
"as_of_date": "2026-10-09",
"design_registration_id": "DSR:wipo_hague:EMID.001431738-0001",
"designer_names": [
"Example designer"
],
"has_readable_image": 1,
"holder_names": [
"Example holder"
],
"image_count": 5,
"primary_identifier": "001431738",
"simple_legal_status": "inactive",
"title_en": "Bottles"
}
],
"returned": 1
},
"request_id": "example-request"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Campos de respuesta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
code | integer | obligatorio | 0 significa aceptado o exitoso; no cero es un error de plataforma. |
cost | string | obligatorio | Se pasó milisegundos, nunca créditos; -1 peticiones externas de la web. |
data | any | obligatorio | Valor de Data usado por esta operación de API. |
msg | string | null | obligatorio | Valor de Msg usado por esta operación de API. |
time | string | obligatorio | Hora local del servidor: aaaa-mm-dd HH:mm:ss. |
traceId | string | null | obligatorio | Valor de Trace id usado por esta operación de API. |
ts | string | obligatorio | Epoch milisegundos. |
Opción 1 de cualquier alternativa — requiere data
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | object | obligatorio | Valor de Data usado por esta operación de API. |
data.costTime | any | opcional | Valor de Cost time usado por esta operación de API. |
data.costToken | any | opcional | Valor de Cost token usado por esta operación de API. |
data.data | object | obligatorio | Sobre de origen retenido dentro de la carga útil de la puerta de enlace. Ejemplo: {} |
data.data.code | string | obligatorio | El éxito está bien. DATA_DESIGN_NOT_FOUND (404) significa que no se ha encontrado ningún detalle de la fuente, no falta de derechos. Preservar errores reales de origen/configuración e identificadores de solicitud; no reintentar, dividir o cambiar el modo de búsqueda automáticamente. Autenticación, créditos y fallos de permisos siguen siendo distintos. Ejemplo: OK |
data.data.data | object | obligatorio | Resultado de los detalles del registro. Ejemplo: {} |
data.data.data.asset | any | opcional | Valor de Asset usado por esta operación de API. |
data.data.data.asset_code | any | opcional | Valor de Asset code usado por esta operación de API. |
data.data.data.execution | any | opcional | Valor de Execution usado por esta operación de API. |
data.data.data.items | array | obligatorio | Todos los registros de registro devueltos en orden de origen; no hay conclusión de infracción. Ejemplo: [{"as_of_date":"2026-10-09","design_registration_id":"DSR:wipo_hague:EMID.001431738-0001","designer_names":["Example designer"],"has_readable_image":1,"holder_names":["Example holder"],"image_count":5,"primary_identifier":"001431738","simple_legal_status":"inactive","title_en":"Bottles"}] |
data.data.data.items[] | object | obligatorio | Elemento de data data data items. |
data.data.data.items[].application_date | any | opcional | Valor de Application date usado por esta operación de API. |
data.data.data.items[].application_number | any | opcional | Valor de Application number usado por esta operación de API. |
data.data.data.items[].as_of_date | any | opcional | Valor de As of date usado por esta operación de API. |
data.data.data.items[].classification_count | any | opcional | Valor de Classification count usado por esta operación de API. |
data.data.data.items[].coverage_level | any | opcional | Valor de Coverage level usado por esta operación de API. |
data.data.data.items[].data_quality_level | any | opcional | Valor de Data quality level usado por esta operación de API. |
data.data.data.items[].data_version | any | opcional | Valor de Data version usado por esta operación de API. |
data.data.data.items[].design_registration_id | any | opcional | Valor de Design registration id usado por esta operación de API. |
data.data.data.items[].designer_names | any | opcional | Valor de Designer names usado por esta operación de API. |
data.data.data.items[].has_readable_image | any | opcional | Valor de Has readable image usado por esta operación de API. |
data.data.data.items[].holder_names | any | opcional | Valor de Holder names usado por esta operación de API. |
data.data.data.items[].image_count | any | opcional | Valor de Image count usado por esta operación de API. |
data.data.data.items[].jurisdiction_iso2 | any | opcional | Valor de Jurisdiction iso2 usado por esta operación de API. |
data.data.data.items[].locarno_classes | any | opcional | Valor de Locarno classes usado por esta operación de API. |
data.data.data.items[].party_count | any | opcional | Valor de Party count usado por esta operación de API. |
data.data.data.items[].primary_identifier | any | opcional | Valor de Primary identifier usado por esta operación de API. |
data.data.data.items[].publication_date | any | opcional | Valor de Publication date usado por esta operación de API. |
data.data.data.items[].publication_number | any | opcional | Valor de Publication number usado por esta operación de API. |
data.data.data.items[].raw_status | any | opcional | Valor de Raw status usado por esta operación de API. |
data.data.data.items[].registration_date | any | opcional | Valor de Registration date usado por esta operación de API. |
data.data.data.items[].registration_jurisdiction | any | opcional | Valor de Registration jurisdiction usado por esta operación de API. |
data.data.data.items[].registration_jurisdiction_code | any | opcional | Valor de Registration jurisdiction code usado por esta operación de API. |
data.data.data.items[].registration_number | any | opcional | Valor de Registration number usado por esta operación de API. |
data.data.data.items[].right_type | any | opcional | Valor de Right type usado por esta operación de API. |
data.data.data.items[].simple_legal_status | any | opcional | Valor de Simple legal status usado por esta operación de API. |
data.data.data.items[].text_count | any | opcional | Valor de Text count usado por esta operación de API. |
data.data.data.items[].title | any | opcional | Valor de Title usado por esta operación de API. |
data.data.data.items[].title_en | any | opcional | Valor de Title en usado por esta operación de API. |
data.data.data.items[].title_en_source | any | opcional | Valor de Title en source usado por esta operación de API. |
data.data.data.items[].title_language | any | opcional | Valor de Title language usado por esta operación de API. |
data.data.data.returned | any | opcional | Valor de Returned usado por esta operación de API. |
data.data.message | any | opcional | Valor de Message usado por esta operación de API. |
data.data.request_id | any | opcional | Valor de Request id usado por esta operación de API. |
data.data.usage | any | opcional | Valor de Usage usado por esta operación de API. |
data.dataSnapshotMonth | any | opcional | Valor de Data snapshot month usado por esta operación de API. |
data.page | any | opcional | Valor de Page usado por esta operación de API. |
data.pageItemCount | any | opcional | Valor de Page item count usado por esta operación de API. |
data.pageSize | any | opcional | Valor de Page size usado por esta operación de API. |
data.requestId | any | opcional | Valor de Request id usado por esta operación de API. |
data.sourceTool | any | opcional | Valor de Source tool usado por esta operación de API. |
data.sourceType | any | opcional | Valor de Source type usado por esta operación de API. |
data.title | any | opcional | Valor de Title usado por esta operación de API. |
data.totalPage | any | opcional | Valor de Total page usado por esta operación de API. |
data.type | any | opcional | Valor de Type usado por esta operación de API. |
data.upstreamRequestId | any | opcional | Valor de Upstream request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costTime | integer | opcional | Tiempo de ejecución comunicado por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costTime | null | opcional | Valor de Cost time usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costToken | integer | opcional | Coste de la señal comunicado por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.costToken | null | opcional | Valor de Cost token usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.asset | string | opcional | Identificador de activos de origen. Ejemplo: asset.design_profile |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.asset | null | opcional | Valor de Asset usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.asset_code | string | opcional | Código de activos de origen. Ejemplo: asset_ipr_design_profile |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.asset_code | null | opcional | Valor de Asset code usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.execution | object | opcional | Metadatos de ejecución de origen opcional. Ejemplo: {} |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.execution | null | opcional | Valor de Execution usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].application_date | string | opcional | Fecha de la aplicación, AAAA-MM-DD. Ejemplo: 2020-01-01 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].application_date | null | opcional | Valor de Application date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].application_number | string | opcional | Número de aplicación de origen; conservar los ceros principales. Ejemplo: example-application |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].application_number | null | opcional | Valor de Application number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].as_of_date | string | opcional | Fecha de confirmación de la fuente, no necesariamente hoy. Ejemplo: 2026-10-09 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].as_of_date | null | opcional | Valor de As of date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].classification_count | integer | opcional | Cuenta de datos de origen; los valores faltantes siguen siendo desconocidos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].classification_count | null | opcional | Valor de Classification count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].coverage_level | string | opcional | Nivel de cobertura de la fuente; no hay garantía de integridad. Ejemplo: detail_ready |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].coverage_level | null | opcional | Valor de Coverage level usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].data_quality_level | string | opcional | Nivel de calidad de los datos de origen; falta de significa desconocido. Ejemplo: usable |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].data_quality_level | null | opcional | Valor de Data quality level usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].data_version | string | opcional | Versión de datos de origen. Ejemplo: example-version |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].data_version | null | opcional | Valor de Data version usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].design_registration_id | string | opcional | Identificación exacta. Ejemplo: DSR:wipo_hague:EMID.001431738-0001 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].design_registration_id | null | opcional | Valor de Design registration id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].designer_names | array | opcional | Diseñadores de fuentes, cuando se conocen. Ejemplo: ["Example designer"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].designer_names | null | opcional | Valor de Designer names usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].has_readable_image | integer | opcional | Indicación de los medios de origen; no una imagen URL. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].has_readable_image | null | opcional | Valor de Has readable image usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].holder_names | array | opcional | Los titulares de fuentes, cuando se conocen. Ejemplo: ["Example holder"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].holder_names | null | opcional | Valor de Holder names usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].image_count | integer | opcional | Conteo de imágenes de origen; no construya enlaces de descarga. Ejemplo: 5 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].image_count | null | opcional | Valor de Image count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].jurisdiction_iso2 | string | opcional | Competencia de dos letras; EM representa a la UE. Ejemplo: EM |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].jurisdiction_iso2 | null | opcional | Valor de Jurisdiction iso2 usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].locarno_classes | array | opcional | Fuente Locarno clases; preservar ceros principales. Ejemplo: ["09-01"] |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].locarno_classes | null | opcional | Valor de Locarno classes usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].party_count | integer | opcional | Cuenta de datos de origen; los valores faltantes siguen siendo desconocidos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].party_count | null | opcional | Valor de Party count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].primary_identifier | string | opcional | Número primario; conservar ceros principales. Ejemplo: 001431738 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].primary_identifier | null | opcional | Valor de Primary identifier usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].publication_date | string | opcional | Fecha de publicación: AAAA-MM-DD. Ejemplo: 2020-03-01 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].publication_date | null | opcional | Valor de Publication date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].publication_number | string | opcional | Número de publicación de la fuente. Ejemplo: example-publication |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].publication_number | null | opcional | Valor de Publication number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].raw_status | string | opcional | Estado original de origen desmapado. Ejemplo: DEL |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].raw_status | null | opcional | Valor de Raw status usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_date | string | opcional | Fecha de inscripción: AAAA-MM-DD. Ejemplo: 2020-02-01 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_date | null | opcional | Valor de Registration date usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction | string | opcional | Valor original de la jurisdicción de la fuente. Ejemplo: EM |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction | null | opcional | Valor de Registration jurisdiction usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction_code | string | opcional | Código original de jurisdicción de origen. Ejemplo: EMID |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_jurisdiction_code | null | opcional | Valor de Registration jurisdiction code usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_number | string | opcional | Número de registro de origen, no una identificación de registro construida. Ejemplo: example-registration |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].registration_number | null | opcional | Valor de Registration number usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].right_type | string | opcional | Fuente derecha tipo. Ejemplo: registered_design |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].right_type | null | opcional | Valor de Right type usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].simple_legal_status | string | opcional | Origen de la condición jurídica; no infiere valores faltantes. Ejemplo: inactive |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].simple_legal_status | null | opcional | Valor de Simple legal status usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].text_count | integer | opcional | Cuenta de datos de origen; los valores faltantes siguen siendo desconocidos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].text_count | null | opcional | Valor de Text count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title | string | opcional | Título original de la fuente. Ejemplo: Bottles |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title | null | opcional | Valor de Title usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_en | string | opcional | Fuente Título en inglés; no traducir de forma independiente. Ejemplo: Bottles |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_en | null | opcional | Valor de Title en usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_en_source | string | opcional | Procedencia del título inglés. Ejemplo: source |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_en_source | null | opcional | Valor de Title en source usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_language | string | opcional | Lenguaje fuente del título; puede ser desconocido. Ejemplo: unknown |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.items[].title_language | null | opcional | Valor de Title language usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.returned | integer | opcional | Número de registros devueltos, no el tamaño del conjunto de datos. Ejemplo: 1 |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.data.returned | null | opcional | Valor de Returned usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.message | string | opcional | Mensaje de estado de origen. Ejemplo: success |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.message | null | opcional | Valor de Message usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.request_id | string | opcional | Identificador de la solicitud de origen. Ejemplo: example-request |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.request_id | null | opcional | Valor de Request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.usage | object | opcional | Uso de la fuente bruta, no facturación del usuario o saldo. Ejemplo: {} |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.data.usage | null | opcional | Valor de Usage usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.dataSnapshotMonth | string | opcional | Mes de instantánea de datos devuelto por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.dataSnapshotMonth | null | opcional | Valor de Data snapshot month usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.page | integer | opcional | Página actual devuelta por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.page | null | opcional | Valor de Page usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageItemCount | integer | opcional | El artículo cuenta con la página actual devuelta por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageItemCount | null | opcional | Valor de Page item count usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageSize | integer | opcional | Tamaño de página devuelto por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.pageSize | null | opcional | Valor de Page size usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.requestId | string | opcional | Identificador de la solicitud de error de pasarela/servicio, distinto del de la fase anterior request_id. Ejemplo: gateway_example |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.requestId | null | opcional | Valor de Request id usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceTool | string | opcional | Nombre de la herramienta de fuente específica del proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceTool | null | opcional | Valor de Source tool usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceType | string | opcional | Tipo de plataforma de origen específico para el proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.sourceType | null | opcional | Valor de Source type usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.title | string | opcional | Título de respuesta específico del proveedor. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.title | null | opcional | Valor de Title usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPage | integer | opcional | El total de páginas devueltas por el proveedor de aguas arriba. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.totalPage | null | opcional | Valor de Total page usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.type | string | opcional | Rendición específica del proveedor o tipo de carga útil. Ejemplo: null |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.type | null | opcional | Valor de Type usado por esta operación de API. |
Opción 1 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.upstreamRequestId | string | opcional | Identificador de solicitud de origen extraído. Ejemplo: req_example |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data.upstreamRequestId | null | opcional | Valor de Upstream request id usado por esta operación de API. |
Opción 2 de cualquier alternativa
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
data | null | obligatorio | Valor de Data usado por esta operación de API. |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta HTTP predeterminada tanto para el éxito como para muchos errores de negocio. Solo el código JSON externo 0 indica éxito o aceptación asíncrona; consulta data para obtener el resultado. |
| 429 | Límite de admisión de ejecuciones; respeta Retry-After cuando esté presente. |
| 503 | La admisión de ejecuciones no está disponible temporalmente; respeta Retry-After cuando esté presente. |
| Opcional | X-Nexscope-Http-Status: semantic asigna estados HTTP a los errores de negocio gestionados por el controlador en las rutas de ejecución y tareas. Los fallos previos a la autenticación, como la ausencia de una clave API (code 11209), pueden seguir devolviendo HTTP 200 antes de esta asignación. Comprueba siempre el código JSON externo; las solicitudes malformadas y los fallos de infraestructura también pueden devolver respuestas HTTP distintas de 200. |
Fuente de datos, vigencia y limitaciones
La fuente, la vigencia, la cobertura, los límites de frecuencia y las notas de estimación no se especifican en esta definición de API salvo que aparezcan en la documentación de campos de solicitud o respuesta anterior. No supongas datos oficiales del mercado ni actualización en tiempo real cuando no estén documentados explícitamente.