Created
February 27, 2024 21:27
-
-
Save andreasevers/a0614fb3ac4418a7f9304ba70229b8d5 to your computer and use it in GitHub Desktop.
This file contains 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.0 | |
| servers: | |
| - description: RS Reporter Production API | |
| url: https://reporter.rs.korfinancial.com | |
| - description: RS Reporter Integration API | |
| url: https://reporter.rs.int.korfinancial.com | |
| info: | |
| x-audience: external-public | |
| x-api-id: 6FC2087B-10B8-4543-9908-FC93835AC5F4 | |
| description: Provides services for managing and running reports within RS | |
| version: 1.0.0 | |
| title: RS Reports API | |
| contact: | |
| name: KOR Engineering | |
| email: support@korfinancial.com | |
| url: https://www.korfinancial.com/ | |
| license: | |
| name: Apache 2.0 | |
| url: https://www.apache.org/licenses/LICENSE-2.0.html | |
| paths: | |
| /types: | |
| get: | |
| tags: | |
| - types | |
| summary: Get report types | |
| description: Query the types for report generation | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: query | |
| name: includeExperimental | |
| description: filters out the experimental reports | |
| required: false | |
| schema: | |
| type: boolean | |
| responses: | |
| 200: | |
| description: Report Type Retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportTypes' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /types/{typeId}: | |
| get: | |
| tags: | |
| - types | |
| summary: Get a single report type by id | |
| description: Query the report types using the id of the type | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: typeId | |
| description: The KOR created GUID id for the report type | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| responses: | |
| 200: | |
| description: Report Type Retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportType' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 404: | |
| $ref: '#/components/responses/404' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /definitions: | |
| get: | |
| tags: | |
| - definitions | |
| summary: Get report definitions | |
| description: Query the definitions for report generation | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: query | |
| name: entityId | |
| description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: query | |
| name: cursor | |
| description: The cursor to get the next page, empty returns the first page | |
| schema: | |
| type: string | |
| - in: query | |
| name: query | |
| description: Base64-encoded string containing the search query | |
| required: false | |
| schema: | |
| type: string | |
| example: '%7B%22p%22%3A%5B%22messageType%22%5D%2C%22cf%22%3A%22eq%22%2C%22v%22%3A%5B%22TRANSACTION%22%2C%22PUBLIC%22%5D%7D' | |
| - in: query | |
| name: pageSize | |
| description: Max amount of results that should be returned | |
| required: false | |
| schema: | |
| type: integer | |
| - in: query | |
| name: scroll | |
| description: A flag to define you intent to scroll through your results. Defaults to true | |
| required: false | |
| schema: | |
| type: boolean | |
| - in: query | |
| name: experimental | |
| description: A flag to define whether you want to include report definitions created for experimental ReportTypes. Defaults to false. | |
| required: false | |
| schema: | |
| type: boolean | |
| responses: | |
| 200: | |
| description: Report definitions retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportDefinitionsSearchResult' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /clients/{entityId}/definitions: | |
| post: | |
| tags: | |
| - definitions | |
| summary: Submit a report definition | |
| description: Submits a new report definition for the report scheduler to execute | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: entityId | |
| description: Your KOR client identifier. Your admin can obtain this identifier from the KOR Central UI under client client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| requestBody: | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportDefinitionCreationRequest' | |
| responses: | |
| 202: | |
| description: Report Definition Accepted | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportDefinitionAccepted' | |
| headers: | |
| Location: | |
| description: The URI of the newly created report definition | |
| schema: | |
| type: string | |
| example: https://reporter.<placeholder>.<placeholder>.korfinancial.com/clients/EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB/definitions/abcd-1111-defg-abc123 | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /definitions/{definitionId}: | |
| get: | |
| tags: | |
| - definitions | |
| summary: Get a single report definition by id | |
| description: Query the report definitions using the id of the definitions | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: definitionId | |
| description: The KOR created GUID id for the report | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: query | |
| name: entityId | |
| description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| responses: | |
| 200: | |
| description: Report Definition Retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportDefinitionResponse' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 404: | |
| $ref: '#/components/responses/404' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /definitions/{definitionId}/jobs: | |
| get: | |
| tags: | |
| - jobs | |
| summary: Get jobs for a report definition | |
| description: Query the jobs for a report definition | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: definitionId | |
| description: The KOR created GUID id for the report definition | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: query | |
| name: entityId | |
| description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: query | |
| name: cursor | |
| description: The cursor to get the next page, empty returns the first page | |
| schema: | |
| type: string | |
| responses: | |
| 200: | |
| description: Report Job Retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportJobsSearchResult' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /definitions/{definitionId}/jobs/{jobId}: | |
| get: | |
| tags: | |
| - jobs | |
| summary: Get the state and status of a single job | |
| description: Returns the state and status of a job for a report by definitionId and reportJobId | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: definitionId | |
| description: The KOR created GUID id for the report definition | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: path | |
| name: jobId | |
| description: The KOR created GUID id for the job | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: ddfba3e8-478c-11ec-81d3-0242ac130003 | |
| - in: query | |
| name: entityId | |
| description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| responses: | |
| 200: | |
| description: Report Retrieved | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportJobResponse' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 404: | |
| $ref: '#/components/responses/404' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| /definitions/{definitionId}/jobs/{jobId}/report: | |
| get: | |
| tags: | |
| - jobs | |
| summary: Downloads the report that has been generated by a report job | |
| description: Downloads the report as a binary stream into a csv or json file | |
| security: | |
| - OAuth2: | |
| - openid | |
| parameters: | |
| - in: path | |
| name: definitionId | |
| description: The KOR created GUID id for the report definition | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: path | |
| name: jobId | |
| description: The KOR created GUID id for the job result | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: 0AB1FCA2-478D-11EC-81D3-0242AC130003 | |
| - in: query | |
| name: entityId | |
| description: Your KOR entity identifier. Your admin can obtain this identifier from the KOR Central UI under entity client details. | |
| required: true | |
| schema: | |
| type: string | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| - in: query | |
| name: format | |
| description: | | |
| The format in which the report should be delivered | |
| <br> x-extensible-enum: <small> | |
| - JSON | |
| - CSV | |
| - REGULATOR | |
| </small> | |
| schema: | |
| type: string | |
| example: CSV | |
| x-extensible-enum: | |
| - JSON | |
| - CSV | |
| - REGULATOR | |
| - in: query | |
| name: csvDelimiter | |
| description: The character used to separate column values when using the CSV format. Default is comma (',') | |
| schema: | |
| type: string | |
| example: '|' | |
| minLength: 1 | |
| maxLength: 1 | |
| - in: query | |
| name: fileName | |
| description: The file name that will be given to the downloaded file | |
| required: false | |
| schema: | |
| type: string | |
| example: fileName | |
| responses: | |
| 200: | |
| description: Temporary URL location of the report | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ReportDownloadResponse' | |
| 400: | |
| $ref: '#/components/responses/400' | |
| 401: | |
| $ref: '#/components/responses/401' | |
| 403: | |
| $ref: '#/components/responses/403' | |
| 404: | |
| $ref: '#/components/responses/404' | |
| 405: | |
| $ref: '#/components/responses/405' | |
| 406: | |
| $ref: '#/components/responses/406' | |
| 415: | |
| $ref: '#/components/responses/415' | |
| 500: | |
| $ref: '#/components/responses/500' | |
| 504: | |
| $ref: '#/components/responses/504' | |
| default: | |
| $ref: '#/components/responses/default' | |
| components: | |
| responses: | |
| 400: | |
| description: Bad Request | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 401: | |
| description: Unauthorized | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 403: | |
| description: Forbidden | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 404: | |
| description: Not Found | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 405: | |
| description: Method Not Allowed | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 406: | |
| description: Not Acceptable | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 415: | |
| description: Unsupported Media Type | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 500: | |
| description: Internal Server Error | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| 504: | |
| description: Gateway Timeout | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| default: | |
| description: Internal Server Error | |
| content: | |
| application/problem+json: | |
| schema: | |
| $ref: '#/components/schemas/Problem' | |
| schemas: | |
| Permissions: | |
| type: object | |
| description: Experimental. The permissions the user has on a resource | |
| properties: | |
| canEdit: | |
| type: boolean | |
| description: Experimental. Whether a user can edit the resource | |
| example: true | |
| canDelete: | |
| type: boolean | |
| description: Experimental. Whether a user can delete the resource | |
| example: true | |
| ReportTypes: | |
| type: object | |
| description: Array of report types | |
| required: | |
| - reportTypes | |
| properties: | |
| reportTypes: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ReportType' | |
| ReportType: | |
| type: object | |
| description: The type of report | |
| required: | |
| - id | |
| - jurisdictions | |
| - group | |
| - name | |
| - queryParameterDefinitions | |
| properties: | |
| id: | |
| type: string | |
| format: uuid | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| jurisdictions: | |
| type: array | |
| items: | |
| type: string | |
| example: CFTC | |
| group: | |
| description: The name of the group that reportType belongs. Currently "KOR" or "CFTC" | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| example: KOR | |
| name: | |
| description: The name associated to the type | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| example: DEFAULT | |
| category: | |
| description: The category associated to the type | |
| type: string | |
| example: Missing | |
| queryParameterDefinitions: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SingleFieldQueryParameterDefinition' | |
| significantFields: | |
| description: The category associated to the type | |
| type: array | |
| items: | |
| type: string | |
| SingleFieldQueryParameterDefinition: | |
| type: object | |
| description: Contains options for clients to build a query clause | |
| required: | |
| - field | |
| - allowedType | |
| - allowedComparisonOperators | |
| properties: | |
| field: | |
| type: string | |
| description: name of the parameter | |
| example: assetClass | |
| group: | |
| type: string | |
| description: group of the parameter | |
| example: Id Fields | |
| groupLogicalOperator: | |
| type: string | |
| description: The logical operator of the group | |
| x-extensible-enum: | |
| - AND, | |
| - OR | |
| example: OR | |
| mandatory: | |
| type: boolean | |
| description: Whether this parameter is mandatory | |
| significant: | |
| type: boolean | |
| description: Whether this parameter is significant | |
| allowedType: | |
| description: | | |
| The type of the parameter | |
| <br> x-extensible-enum: <small> - BOOLEAN - STRING - TIMESTAMP - NUMBER - DAYSTAMP - DAYSTAMP_RANGE - TIMESTAMP_RANGE </small> | |
| type: string | |
| x-extensible-enum: | |
| - BOOLEAN | |
| - STRING | |
| - TIMESTAMP | |
| - NUMBER | |
| - DAYSTAMP | |
| - DAYSTAMP_RANGE | |
| - TIMESTAMP_RANGE | |
| allowedComparisonOperators: | |
| description: | | |
| The comparison operators that are allowed for the parameter | |
| <br> x-extensible-enum: <small> | |
| - BETWEEN | |
| - UNTIL | |
| - IS | |
| - IS_ANY_OF | |
| - IS_NOT | |
| - IS_NONE_OF | |
| - IS_EMPTY | |
| - IS_NOT_EMPTY | |
| - AS_OF | |
| </small> | |
| type: array | |
| items: | |
| type: string | |
| x-extensible-enum: | |
| - BETWEEN | |
| - UNTIL | |
| - IS | |
| - IS_ANY_OF | |
| - IS_NOT | |
| - IS_NONE_OF | |
| - IS_EMPTY | |
| - IS_NOT_EMPTY | |
| - AS_OF | |
| example: | |
| - IS_EMPTY | |
| allowedValues: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ParameterDefinitionValue' | |
| ParameterDefinitionValue: | |
| required: | |
| - type | |
| type: object | |
| properties: | |
| type: | |
| description: | | |
| The type of the parameter | |
| <br> x-extensible-enum: <small> | |
| - BOOLEAN | |
| - STRING | |
| - TIMESTAMP | |
| - NUMBER | |
| - DAYSTAMP | |
| - DAYSTAMP_RANGE | |
| - TIMESTAMP_RANGE | |
| </small> | |
| type: string | |
| x-extensible-enum: | |
| - BOOLEAN | |
| - STRING | |
| - TIMESTAMP | |
| - NUMBER | |
| - DAYSTAMP | |
| - DAYSTAMP_RANGE | |
| - TIMESTAMP_RANGE | |
| example: TIMESTAMP | |
| value: {} | |
| label: | |
| type: string | |
| example: Message Submission Timestamp | |
| contextualData: | |
| type: object | |
| ReportDefinitionCreationRequest: | |
| type: object | |
| required: | |
| - name | |
| - reportTypeId | |
| - queryParameter | |
| properties: | |
| name: | |
| description: The name associated to the report | |
| type: string | |
| example: TradingReport | |
| pattern: '[!-~]{1,256}' | |
| maxLength: 120 | |
| reportTypeId: | |
| type: string | |
| format: uuid | |
| example: 7508957e-4847-11ec-81d3-0242ac130003 | |
| queryParameter: | |
| $ref: '#/components/schemas/QueryParameter' | |
| ReportDefinitionResponse: | |
| type: object | |
| required: | |
| - id | |
| - entityId | |
| - userId | |
| - name | |
| - reportType | |
| - queryParameter | |
| - createdTimestamp | |
| - permissions | |
| properties: | |
| id: | |
| type: string | |
| format: uuid | |
| description: The KOR GUID id for this report definition, is always unique | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| entityId: | |
| type: string | |
| format: uuid | |
| description: The KOR client entity identifier | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| userId: | |
| type: string | |
| description: Entity who created report | |
| name: | |
| description: The name associated to the report definition | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| reportType: | |
| $ref: '#/components/schemas/ReportType' | |
| queryParameter: | |
| $ref: '#/components/schemas/QueryParameter' | |
| createdTimestamp: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| lastJob: | |
| $ref: '#/components/schemas/ReportJobSummary' | |
| lastSuccessfulJob: | |
| $ref: '#/components/schemas/ReportJobSummary' | |
| permissions: | |
| $ref: '#/components/schemas/Permissions' | |
| ReportDefinitionsSearchResult: | |
| type: object | |
| description: The search result with a cursor, indicating whether there are more items and the returned (subset of) report definitions. | |
| required: | |
| - hasMore | |
| - items | |
| properties: | |
| cursor: | |
| description: Cursor for the current search request. | |
| type: string | |
| hasMore: | |
| description: Indicating whether there are more report definitions that can be retrieved. | |
| type: boolean | |
| items: | |
| description: The list of items | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ReportDefinitionListResponse' | |
| ReportDefinitionListResponse: | |
| type: object | |
| required: | |
| - permissions | |
| - id | |
| - entityId | |
| - userId | |
| - name | |
| - reportTypeId | |
| - reportTypeGroup | |
| - reportTypeName | |
| - queryParameter | |
| - createdTimestamp | |
| properties: | |
| id: | |
| type: string | |
| format: uuid | |
| description: The KOR GUID id for this report definition, is always unique | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| entityId: | |
| type: string | |
| format: uuid | |
| description: The KOR client entity identifier | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| userId: | |
| type: string | |
| description: Entity who created report | |
| name: | |
| description: The name associated to the report definition | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| reportTypeId: | |
| type: string | |
| format: uuid | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| reportTypeGroup: | |
| description: The name of the group that reportType belongs. Currently "KOR" or "CFTC" | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| example: KOR | |
| reportTypeName: | |
| description: The name associated to the type | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| example: DEFAULT | |
| queryParameter: | |
| $ref: '#/components/schemas/QueryParameter' | |
| createdTimestamp: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| lastJob: | |
| $ref: '#/components/schemas/ReportJobSummary' | |
| lastSuccessfulJob: | |
| $ref: '#/components/schemas/ReportJobSummary' | |
| permissions: | |
| $ref: '#/components/schemas/Permissions' | |
| ReportJobSummary: | |
| type: object | |
| required: | |
| - id | |
| - status | |
| properties: | |
| id: | |
| type: string | |
| format: uuid | |
| description: id of the job | |
| example: E843666-9018-4BC9-B863-89EFC524AA6D | |
| status: | |
| $ref: '#/components/schemas/JobStatus' | |
| startTimestamp: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| endTimestamp: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| JobStatus: | |
| type: string | |
| description: | | |
| The status of the job | |
| <br> x-extensible-enum: <small> | |
| - STARTED | |
| - SUCCESS | |
| - FAILED | |
| - NEW | |
| - TIMEDOUT | |
| </small> | |
| example: SCHEDULED | |
| x-extensible-enum: | |
| - STARTED | |
| - SUCCESS | |
| - FAILED | |
| - NEW | |
| - TIMEDOUT | |
| ReportJobsSearchResult: | |
| type: object | |
| description: The search result with a cursor, indicating whether there are more items and the returned (subset of) report jobs. | |
| required: | |
| - hasMore | |
| - items | |
| properties: | |
| cursor: | |
| description: Cursor for the current search request. | |
| type: string | |
| hasMore: | |
| description: Indicating whether there are more report jobs that can be retrieved. | |
| type: boolean | |
| items: | |
| description: The list of items | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ReportJobResponse' | |
| ReportJobResponse: | |
| type: object | |
| required: | |
| - id | |
| - entityId | |
| - subjectId | |
| - status | |
| properties: | |
| id: | |
| type: string | |
| format: uuid | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| entityId: | |
| type: string | |
| description: The KOR client entity identifier | |
| format: uuid | |
| example: EE740BB0-F854-4054-B5DB-0EAA6B3F6DBB | |
| subjectId: | |
| type: string | |
| description: Entity who created report | |
| example: user1 | |
| definition: | |
| $ref: '#/components/schemas/ReportJobDefinition' | |
| queryParameterOverride: | |
| $ref: '#/components/schemas/QueryParameter' | |
| start: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| end: | |
| type: string | |
| format: date-time | |
| example: "2020-05-28T14:07:17Z" | |
| status: | |
| $ref: '#/components/schemas/JobStatus' | |
| error: | |
| type: string | |
| description: the error indicating why the job failed | |
| ReportJobDefinition: | |
| type: object | |
| required: | |
| - definitionId | |
| - definitionName | |
| - typeId | |
| - typeName | |
| - typeGroup | |
| - queryParameterDefinitions | |
| properties: | |
| definitionId: | |
| type: string | |
| format: uuid | |
| description: The KOR GUID id for this report job definition, is always unique | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| definitionName: | |
| description: The name associated to the report job definition | |
| type: string | |
| pattern: '[!-~]{1,256}' | |
| typeId: | |
| type: string | |
| description: id of the report type | |
| typeName: | |
| type: string | |
| description: name of the report type | |
| typeGroup: | |
| type: string | |
| description: group to which the report type belongs | |
| queryParameterDefinitions: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SingleFieldQueryParameterDefinition' | |
| queryParameter: | |
| $ref: '#/components/schemas/QueryParameter' | |
| QueryParameter: | |
| type: object | |
| example: | |
| logicalOperator: AND | |
| queryParameters: | |
| - logicalOperator: OR | |
| group: IDFields | |
| queryParameters: | |
| - field: counterparty1 | |
| comparisonOperator: IS | |
| value: | |
| - type: STRING | |
| value: FAKE0022222222222200 | |
| description: Object used to configure parameters for a report. You can model both parameters and groups of parameters in a recursive way. This object is being used to configure parameters during ReportDefinition creation as well as when creating ReportJobs, to override the parameters of the ReportDefinition. Using the object when creating a ReportJob, the object completely overrides the parameters of the ReportDefinition. When not using the object when creating a ReportJob, the job will run with the parameters defined on the ReportDefinition. | |
| properties: | |
| logicalOperator: | |
| type: string | |
| example: OR | |
| x-extensible-enum: | |
| - AND | |
| - OR | |
| queryParameters: | |
| type: array | |
| description: group of query parameters where the logicalOperator is applied on | |
| items: | |
| $ref: '#/components/schemas/QueryParameter' | |
| field: | |
| type: string | |
| description: field name of the parameter | |
| comparisonOperator: | |
| description: | | |
| The comparison operator that is used for the parameter | |
| <br> x-extensible-enum: <small> | |
| - BETWEEN | |
| - UNTIL | |
| - IS | |
| - IS_ANY_OF | |
| - IS_NOT | |
| - IS_NONE_OF | |
| - IS_EMPTY | |
| - IS_NOT_EMPTY | |
| - AS_OF | |
| </small> | |
| type: string | |
| example: IS | |
| x-extensible-enum: | |
| - BETWEEN | |
| - UNTIL | |
| - IS | |
| - IS_ANY_OF | |
| - IS_NOT | |
| - IS_NONE_OF | |
| - IS_EMPTY | |
| - IS_NOT_EMPTY | |
| - AS_OF | |
| group: | |
| type: string | |
| example: IDFields | |
| value: | |
| type: array | |
| description: list of actual values for the query parameters | |
| items: | |
| $ref: '#/components/schemas/QueryParameterActualValue' | |
| QueryParameterActualValue: | |
| type: object | |
| required: | |
| - type | |
| description: Value of a query parameter | |
| properties: | |
| type: | |
| type: string | |
| value: {} | |
| contextualData: | |
| type: object | |
| ReportDefinitionAccepted: | |
| type: object | |
| required: | |
| - definitionId | |
| properties: | |
| definitionId: | |
| type: string | |
| format: uuid | |
| example: f0406529-8681-4ceb-9197-9db7a24125f2 | |
| Problem: | |
| type: object | |
| properties: | |
| type: | |
| type: string | |
| format: uri-reference | |
| description: | | |
| A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type. | |
| default: about:blank | |
| example: /some/uri-reference | |
| title: | |
| type: string | |
| description: | | |
| A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized. | |
| example: some title for the error situation | |
| status: | |
| type: integer | |
| format: int32 | |
| description: | | |
| The HTTP status code generated by the origin server for this occurrence of the problem. | |
| minimum: 100 | |
| maximum: 600 | |
| exclusiveMaximum: true | |
| detail: | |
| type: string | |
| description: | | |
| A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized. | |
| example: some description for the error situation | |
| instance: | |
| type: string | |
| format: uri-reference | |
| description: | | |
| A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code. | |
| example: /some/uri-reference#specific-occurrence-context | |
| correlationId: | |
| type: string | |
| description: | | |
| A correlation identity referring to the specific occurrence of the problem. | |
| ReportDownloadResponse: | |
| type: object | |
| description: Temporary URL location of the report | |
| properties: | |
| reportDownloadLink: | |
| description: The actual URL temporary location of the report | |
| type: string | |
| securitySchemes: | |
| OAuth2: | |
| type: oauth2 | |
| flows: | |
| clientCredentials: | |
| tokenUrl: https://auth.korfinancial.com/oauth2/token | |
| scopes: | |
| reports/write: Allows write access to submissions | |
| reports/read: Allows read access to submissions | |
| authorizationCode: | |
| authorizationUrl: https://auth.korfinancial.com/login?response_type=code&client_id=7aptdfdbh2hbpm5fkubtntmhnh&redirect_uri=https%3A%2F%2Freporter.rs.korfinancial.com%2Fswagger-ui%2Foauth2-redirect.html | |
| tokenUrl: https://auth.korfinancial.com/oauth2/token | |
| scopes: | |
| openid: Grants user access | |
| security: | |
| - OAuth2: | |
| - openid |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment