Created
April 30, 2025 11:26
-
-
Save alarictabaries/dc3ca71610f18c872e99cb896d3b3d34 to your computer and use it in GitHub Desktop.
Open Patent Services API 3.2 OAS 3.0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.1 | |
| info: | |
| title: Open Patent Services API | |
| version: "3.2" | |
| servers: | |
| - url: https://ops.epo.org/3.2/rest-services | |
| paths: | |
| /published-data/search: | |
| get: | |
| tags: | |
| - Published | |
| summary: Bibliographic data search service | |
| description: Bibliographic data search service | |
| operationId: Published Data Keywords Search without Consituents | |
| parameters: | |
| - name: Range | |
| in: query | |
| description: Range of elements were requested | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| format: string | |
| default: 1-25 | |
| - name: q | |
| in: query | |
| description: Search query | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: ti=plastic | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/search/{constituent}: | |
| get: | |
| tags: | |
| - Published | |
| summary: Bibliographic data search service | |
| description: Bibliographic data search service | |
| operationId: Published Data Keywords Search with Variable Constituents | |
| parameters: | |
| - name: constituent | |
| in: path | |
| description: Constituent | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: biblio | |
| enum: | |
| - biblio | |
| - full-cycle | |
| - abstract | |
| - name: q | |
| in: query | |
| description: Search query | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: ti=plastic | |
| - name: Range | |
| in: query | |
| description: Range of elements were requested | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| format: string | |
| default: 1-25 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/{number}/biblio: | |
| get: | |
| tags: | |
| - Published | |
| summary: Bibliographic data retrieval service | |
| description: Bibliographic data retrieval service | |
| operationId: Published Data Retrieval | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/biblio: | |
| post: | |
| tags: | |
| - Published | |
| summary: Bibliographic data retrieval service | |
| description: Bibliographic data retrieval service | |
| operationId: Published Data Retrieval (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/abstract: | |
| get: | |
| tags: | |
| - Published | |
| summary: Publications abstract service | |
| description: Publications abstract service | |
| operationId: Published Data Abstract Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/abstract: | |
| post: | |
| tags: | |
| - Published | |
| summary: Publications abstract service | |
| description: Publications abstract service | |
| operationId: Published Data Abstract Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/full-cycle: | |
| get: | |
| tags: | |
| - Published | |
| summary: Publications full cycle service | |
| description: Publications full cycle service | |
| operationId: Published Data Full Cycle Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/full-cycle: | |
| post: | |
| tags: | |
| - Published | |
| summary: Publications full cycle service | |
| description: Publications full cycle service | |
| operationId: Published Data Full Cycle Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/fulltext: | |
| get: | |
| tags: | |
| - Published | |
| summary: Fulltext inquiry service | |
| description: Fulltext inquiry service | |
| operationId: Published Data Fulltext Inquiry Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/fulltext: | |
| post: | |
| tags: | |
| - Published | |
| summary: Fulltext inquiry service | |
| description: Fulltext inquiry service | |
| operationId: Published Data Fulltext Inquiry Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/description: | |
| get: | |
| tags: | |
| - Published | |
| summary: Description retrieval service | |
| description: Description retrieval service | |
| operationId: Published Data Description Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/description: | |
| post: | |
| tags: | |
| - Published | |
| summary: Description retrieval service | |
| description: Description retrieval service | |
| operationId: Published Data Description Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/claims: | |
| get: | |
| tags: | |
| - Published | |
| summary: Claims retrieval service | |
| description: Claims retrieval service | |
| operationId: Published Data Claims Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/claims: | |
| post: | |
| tags: | |
| - Published | |
| summary: Claims retrieval service | |
| description: Claims retrieval service | |
| operationId: Published Claims Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/equivalents: | |
| get: | |
| tags: | |
| - Published | |
| summary: Equivalents retrieval service | |
| description: Equivalents retrieval service | |
| operationId: Published Equivalents Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/equivalents: | |
| post: | |
| tags: | |
| - Published | |
| description: Equivalents retrieval service | |
| operationId: Published Equivalents Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/{type}/{format}/{number}/images: | |
| get: | |
| tags: | |
| - Published | |
| description: Images inquiry service | |
| operationId: Published Images Inquiry Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: docdb | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP.1000000.A1 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/{type}/{format}/images: | |
| post: | |
| tags: | |
| - Published | |
| summary: Images inquiry service | |
| description: Images inquiry service | |
| operationId: Published Images Inquiry Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: docdb | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /published-data/images/{image-country}/{image-number}/{image-kind}/{image-type}: | |
| get: | |
| tags: | |
| - Published | |
| summary: Images retrieval service | |
| description: Images retrieval service | |
| operationId: Published Images Retrieval Service | |
| parameters: | |
| - name: image-country | |
| in: path | |
| description: Image Id country code part | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP | |
| - name: image-number | |
| in: path | |
| description: Image Id number part | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: "1000000" | |
| - name: image-kind | |
| in: path | |
| description: Image Id kind part | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: A1 | |
| - name: image-type | |
| in: path | |
| description: Image Id document type part | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: fullimage | |
| - name: Range | |
| in: query | |
| description: Page number | |
| required: true | |
| schema: | |
| type: integer | |
| format: string | |
| default: 1 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/pdf: | |
| schema: | |
| type: string | |
| application/tiff: | |
| schema: | |
| type: string | |
| image/png: | |
| schema: | |
| type: string | |
| image/tiff: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/pdf: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/tiff: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| image/png: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| image/tiff: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /published-data/images: | |
| post: | |
| tags: | |
| - Published | |
| description: Images retrieval service | |
| operationId: Published Images Retrieval Service (POST) | |
| parameters: | |
| - name: Range | |
| in: query | |
| description: Page number | |
| required: true | |
| schema: | |
| type: integer | |
| format: string | |
| default: 1 | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/pdf: | |
| schema: | |
| type: string | |
| application/tiff: | |
| schema: | |
| type: string | |
| image/png: | |
| schema: | |
| type: string | |
| image/tiff: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/pdf: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/tiff: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| image/png: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| image/tiff: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /family/{type}/{format}/{number}: | |
| get: | |
| tags: | |
| - Family | |
| summary: Family retrieval service | |
| description: Family retrieval service | |
| operationId: INPADOC Family Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /family/{type}/{format}: | |
| post: | |
| tags: | |
| - Family | |
| summary: Family retrieval service | |
| description: Family retrieval service | |
| operationId: INPADOC Family Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /family/{type}/{format}/{number}/biblio: | |
| get: | |
| tags: | |
| - Family | |
| summary: Family + biblio retrieval service | |
| description: Family + biblio retrieval service | |
| operationId: INPADOC Family Retrieval Service with Biblio | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /family/{type}/{format}/biblio: | |
| post: | |
| tags: | |
| - Family | |
| summary: Family + biblio retrieval service | |
| description: Family + biblio retrieval service | |
| operationId: INPADOC Family Retrieval Service with Biblio (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /family/{type}/{format}/{number}/legal: | |
| get: | |
| tags: | |
| - Family | |
| summary: Family + legal data retrieval service | |
| description: Family + legal data retrieval service | |
| operationId: INPADOC Family Retrieval Service with Legal | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /family/{type}/{format}/legal: | |
| post: | |
| tags: | |
| - Family | |
| summary: Family + legal data retrieval service | |
| description: Family + legal data retrieval service | |
| operationId: INPADOC Family Retrieval Service with Legal (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /legal/{type}/{format}/{number}: | |
| get: | |
| tags: | |
| - Legal | |
| summary: Legal data retrieval service | |
| description: Legal data retrieval service | |
| operationId: Legal Data Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /legal/{type}/{format}: | |
| post: | |
| tags: | |
| - Legal | |
| summary: Legal data retrieval service | |
| description: Legal data retrieval service | |
| operationId: Legal Data Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - docdb | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /register/search: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register data search service | |
| description: Register data search service | |
| operationId: Register Search Service without Constituents | |
| parameters: | |
| - name: Range | |
| in: query | |
| description: "Range of elements were requested, e.g. 1-20" | |
| schema: | |
| type: string | |
| format: string | |
| default: 1-25 | |
| - name: q | |
| in: query | |
| description: Search query | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: ti=plastic | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/search/{constituent}: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register data search service | |
| description: Register data search service | |
| operationId: Register Search Service with Variable Constituents | |
| parameters: | |
| - name: constituent | |
| in: path | |
| description: Constituent | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: biblio | |
| enum: | |
| - biblio | |
| - events | |
| - procedural-steps | |
| - upp | |
| - name: q | |
| in: query | |
| description: Search query | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: ti=plastic | |
| - name: Range | |
| in: query | |
| description: "Range of elements were requested, e.g. 1-20" | |
| schema: | |
| type: string | |
| format: string | |
| default: 1-25 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/{type}/{format}/{number}/biblio: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register data retrieval service | |
| description: Register data retrieval service | |
| operationId: Register Retrieval Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/{type}/{format}/biblio: | |
| post: | |
| tags: | |
| - Register | |
| summary: Register data retrieval service | |
| description: Register data retrieval service | |
| operationId: Register Retrieval Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /register/{type}/{format}/{number}/events: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register events service | |
| description: Register events service | |
| operationId: Register Events Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/{type}/{format}/events: | |
| post: | |
| tags: | |
| - Register | |
| summary: Register events service | |
| description: Register events service | |
| operationId: Register Events Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /register/{type}/{format}/{number}/procedural-steps: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register procedural steps service | |
| description: Register procedural steps service | |
| operationId: Register Procedural Steps Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/{type}/{format}/procedural-steps: | |
| post: | |
| tags: | |
| - Register | |
| summary: Register procedural steps service | |
| description: Register procedural steps service | |
| operationId: Register Procedural Steps Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /register/{type}/{format}/{number}/upp: | |
| get: | |
| tags: | |
| - Register | |
| summary: Register unitary patent service | |
| description: Register unitary patent service | |
| operationId: Register UNIP Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: EP1000000 | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /register/{type}/{format}/upp: | |
| post: | |
| tags: | |
| - Register | |
| summary: Register unitary patent service | |
| description: Register unitary patent service | |
| operationId: Register UNIP Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: publication | |
| enum: | |
| - application | |
| - publication | |
| - name: format | |
| in: path | |
| description: Reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: epodoc | |
| enum: | |
| - epodoc | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /classification/cpc/{class}: | |
| get: | |
| tags: | |
| - Classification | |
| summary: Classification schema service | |
| description: Classification schema service | |
| operationId: Classification Schema Service | |
| parameters: | |
| - name: class | |
| in: path | |
| description: CPC class name | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: A01B | |
| - name: ancestors | |
| in: query | |
| description: Ancestors flag | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| format: string | |
| enum: | |
| - false | |
| - true | |
| - name: navigation | |
| in: query | |
| description: Navigation flag | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| format: string | |
| enum: | |
| - false | |
| - true | |
| - name: depth | |
| in: query | |
| description: Classification tree traversing depth | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| format: string | |
| enum: | |
| - "0" | |
| - "1" | |
| - "2" | |
| - "3" | |
| - all | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /classification/cpc/{class}/{subclass}: | |
| get: | |
| tags: | |
| - Classification | |
| summary: Classification schema service | |
| description: Classification schema service | |
| operationId: Classification Schema Subclass Service | |
| parameters: | |
| - name: class | |
| in: path | |
| description: CPC class name | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: A01B1 | |
| - name: subclass | |
| in: path | |
| description: CPC subclass name | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: "00" | |
| - name: ancestors | |
| in: query | |
| description: Ancestors flag | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| format: string | |
| enum: | |
| - false | |
| - true | |
| - name: navigation | |
| in: query | |
| description: Navigation flag | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| format: string | |
| enum: | |
| - false | |
| - true | |
| - name: depth | |
| in: query | |
| description: Classification tree traversing depth | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| format: string | |
| enum: | |
| - "0" | |
| - "1" | |
| - "2" | |
| - "3" | |
| - all | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /classification/cpc: | |
| post: | |
| tags: | |
| - Classification | |
| summary: Classification schema service | |
| description: Classification schema service | |
| operationId: Classification Schema Service (POST) | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| x-codegen-request-body-name: body | |
| /classification/cpc/media/{media-name}: | |
| get: | |
| tags: | |
| - Classification | |
| summary: Classification media retrieval service | |
| description: Classification media retrieval service | |
| operationId: Classification Media Service | |
| parameters: | |
| - name: media-name | |
| in: path | |
| description: CPC media resource name | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: 1000.gif | |
| - name: attachment | |
| in: query | |
| description: Attachment/inline content disposition indicator. Inline is a | |
| default value. | |
| schema: | |
| type: boolean | |
| format: string | |
| enum: | |
| - false | |
| - true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| image/gif: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| image/gif: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /classification/cpc/search: | |
| get: | |
| tags: | |
| - Classification | |
| summary: Classification statistics search service | |
| description: Classification statistics search service | |
| operationId: Classification Statistics Service | |
| parameters: | |
| - name: q | |
| in: query | |
| description: Search query | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: plastic | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /classification/map/{input-format}/{class}/{subclass}/{output-format}: | |
| get: | |
| tags: | |
| - Classification | |
| summary: Classification mapping service | |
| description: Classification mapping service | |
| operationId: Classification Mapping Service | |
| parameters: | |
| - name: input-format | |
| in: path | |
| description: Input classification conversion format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: ecla | |
| enum: | |
| - cpc | |
| - ecla | |
| - name: class | |
| in: path | |
| description: Valid | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: A01D2085 | |
| - name: subclass | |
| in: path | |
| description: Valid | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: "8" | |
| - name: output-format | |
| in: path | |
| description: Output classification conversion format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: cpc | |
| enum: | |
| - cpc | |
| - ecla | |
| - ipc | |
| - name: additional | |
| in: query | |
| description: Invention/Additional resolution indicator. Invention is default | |
| value. | |
| required: true | |
| schema: | |
| type: boolean | |
| format: string | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /number-service/{type}/{input-format}/{number}/{output-format}: | |
| get: | |
| tags: | |
| - Number | |
| summary: Number service | |
| description: Number service | |
| operationId: Number Service | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: application | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: input-format | |
| in: path | |
| description: Input reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: original | |
| enum: | |
| - docdb | |
| - original | |
| - name: number | |
| in: path | |
| description: Reference number | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: "JP.(2006-147056).A.20060526" | |
| - name: output-format | |
| in: path | |
| description: Output reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: docdb | |
| enum: | |
| - docdb | |
| - epodoc | |
| - original | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| /number-service/{type}/{input-format}/{output-format}: | |
| post: | |
| tags: | |
| - Number | |
| summary: Number service | |
| description: Number service | |
| operationId: Number Service (POST) | |
| parameters: | |
| - name: type | |
| in: path | |
| description: Reference type | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: application | |
| enum: | |
| - application | |
| - priority | |
| - publication | |
| - name: input-format | |
| in: path | |
| description: Input reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: original | |
| enum: | |
| - docdb | |
| - epodoc | |
| - original | |
| - name: output-format | |
| in: path | |
| description: Output reference format | |
| required: true | |
| schema: | |
| type: string | |
| format: string | |
| default: docdb | |
| enum: | |
| - docdb | |
| - epodoc | |
| - original | |
| requestBody: | |
| description: Request payload | |
| content: | |
| text/plain: | |
| schema: | |
| $ref: '#/components/schemas/Body' | |
| required: true | |
| responses: | |
| "200": | |
| description: Valid | |
| content: | |
| application/xml: | |
| schema: | |
| type: string | |
| application/json: | |
| schema: | |
| type: string | |
| application/javascript: | |
| schema: | |
| type: string | |
| default: | |
| description: Error | |
| content: | |
| application/xml: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| application/javascript: | |
| schema: | |
| $ref: '#/components/schemas/Error' | |
| security: | |
| - client-credentials: [] | |
| components: | |
| schemas: | |
| Body: | |
| type: string | |
| Error: | |
| type: object | |
| properties: | |
| code: | |
| type: string | |
| message: | |
| type: string | |
| xml: | |
| name: fault | |
| securitySchemes: | |
| client-credentials: | |
| type: oauth2 | |
| flows: | |
| clientCredentials: | |
| tokenUrl: https://ops.epo.org/3.2/auth/accesstoken | |
| scopes: {} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment