-
-
Save ahonnecke/55f8ba1f2791d718eec83f4230500f4c to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
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.3 | |
| info: | |
| title: Core API | |
| description: >- | |
| Reference documentation. | |
| Default fields in each resource: `organizationId`, `createdAt`, `createdBy`, | |
| `updatedAt`, `updatedBy` | |
| version: 0.0.0 | |
| servers: | |
| - url: / | |
| description: '' | |
| paths: | |
| /api/core/protected/v1/administration/organization_types: | |
| get: | |
| operationId: getOrganizationTypeCollection | |
| tags: | |
| - OrganizationType | |
| responses: | |
| '200': | |
| description: OrganizationType collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/OrganizationType.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/OrganizationType' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/OrganizationType' | |
| summary: Retrieves the collection of OrganizationType resources. | |
| description: Retrieves the collection of OrganizationType resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/administration/organizations: | |
| get: | |
| operationId: getOrganizationCollection | |
| tags: | |
| - Organization | |
| responses: | |
| '200': | |
| description: Organization collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Organization.jsonld-organization.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Organization-organization.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Organization-organization.list' | |
| summary: Retrieves the collection of Organization resources. | |
| description: Retrieves the collection of Organization resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: website | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[website] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postOrganizationCollection | |
| tags: | |
| - Organization | |
| responses: | |
| '201': | |
| description: Organization resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Organization.jsonld-organization.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| links: | |
| GetOrganizationItem: | |
| operationId: getOrganizationItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/administration/organizations/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Organization resource. | |
| description: Creates a Organization resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Organization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Organization.jsonld-organization.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/administration/organizations/{id}: | |
| get: | |
| operationId: getOrganizationItem | |
| tags: | |
| - Organization | |
| responses: | |
| '200': | |
| description: Organization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Organization.jsonld-organization.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Organization resource. | |
| description: Retrieves a Organization resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putOrganizationItem | |
| tags: | |
| - Organization | |
| responses: | |
| '200': | |
| description: Organization resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Organization.jsonld-organization.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.view' | |
| links: | |
| GetOrganizationItem: | |
| operationId: getOrganizationItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/administration/organizations/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Organization resource. | |
| description: Replaces the Organization resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Organization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Organization.jsonld-organization.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Organization-organization.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/administration/user_organizations: | |
| get: | |
| operationId: getUserOrganizationCollection | |
| tags: | |
| - UserOrganization | |
| responses: | |
| '200': | |
| description: UserOrganization collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.list' | |
| summary: Retrieves the collection of UserOrganization resources. | |
| description: Retrieves the collection of UserOrganization resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: userId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: organizationId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postUserOrganizationCollection | |
| tags: | |
| - UserOrganization | |
| responses: | |
| '201': | |
| description: UserOrganization resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| links: | |
| GetUserOrganizationItem: | |
| operationId: getUserOrganizationItem | |
| parameters: | |
| userId: $response.body#/userId | |
| organizationId: $response.body#/organizationId | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/administration/user_organizations/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a UserOrganization resource. | |
| description: Creates a UserOrganization resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new UserOrganization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/administration/user_organizations/{id}: | |
| get: | |
| operationId: getUserOrganizationItem | |
| tags: | |
| - UserOrganization | |
| responses: | |
| '200': | |
| description: UserOrganization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a UserOrganization resource. | |
| description: Retrieves a UserOrganization resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putUserOrganizationItem | |
| tags: | |
| - UserOrganization | |
| responses: | |
| '200': | |
| description: UserOrganization resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.view' | |
| links: | |
| GetUserOrganizationItem: | |
| operationId: getUserOrganizationItem | |
| parameters: | |
| userId: $response.body#/userId | |
| organizationId: $response.body#/organizationId | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/administration/user_organizations/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the UserOrganization resource. | |
| description: Replaces the UserOrganization resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated UserOrganization resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/UserOrganization.jsonld-user_organization.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserOrganization-user_organization.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteUserOrganizationItem | |
| tags: | |
| - UserOrganization | |
| responses: | |
| '204': | |
| description: UserOrganization resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the UserOrganization resource. | |
| description: Removes the UserOrganization resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/asset_types: | |
| get: | |
| operationId: getAssetTypeCollection | |
| tags: | |
| - AssetType | |
| responses: | |
| '200': | |
| description: AssetType collection | |
| content: | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetType' | |
| summary: Retrieves the collection of AssetType resources. | |
| description: Retrieves the collection of AssetType resources. | |
| parameters: [] | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/attachment/attachments: | |
| get: | |
| operationId: getAttachmentCollection | |
| tags: | |
| - Attachment | |
| responses: | |
| '200': | |
| description: Attachment collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse.jsonld-attachment.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| summary: Retrieves the collection of Attachment resources. | |
| description: Retrieves the collection of Attachment resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAttachmentCollection | |
| tags: | |
| - Attachment | |
| responses: | |
| '201': | |
| description: Attachment resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse.jsonld-attachment.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| links: | |
| GetAttachmentItem: | |
| operationId: getAttachmentItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/attachment/attachments/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Attachment resource. | |
| description: Creates a Attachment resource. | |
| parameters: [] | |
| requestBody: | |
| description: '' | |
| content: | |
| multipart/form-data: | |
| schema: | |
| type: object | |
| properties: | |
| file: | |
| type: string | |
| format: binary | |
| resourceId: | |
| type: string | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/attachment/attachments/resource/{id}: | |
| get: | |
| operationId: get_attachments_for_resource_idAttachmentCollection | |
| tags: | |
| - Attachment | |
| responses: | |
| '200': | |
| description: Attachment collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse.jsonld-attachment.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.list | |
| summary: Retrieves the collection of Attachment resources. | |
| description: Retrieves the collection of Attachment resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/attachment/attachments/{id}: | |
| get: | |
| operationId: getAttachmentItem | |
| tags: | |
| - Attachment | |
| responses: | |
| '200': | |
| description: Attachment resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse.jsonld-attachment.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Attachment resource. | |
| description: Retrieves a Attachment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteAttachmentItem | |
| tags: | |
| - Attachment | |
| responses: | |
| '204': | |
| description: Attachment resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Attachment resource. | |
| description: Removes the Attachment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchAttachmentItem | |
| tags: | |
| - Attachment | |
| responses: | |
| '200': | |
| description: Attachment resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse.jsonld-attachment.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Attachment.AttachmentResponse-attachment.view | |
| links: | |
| GetAttachmentItem: | |
| operationId: getAttachmentItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/attachment/attachments/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the Attachment resource. | |
| description: Updates the Attachment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Attachment resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: '#/components/schemas/Attachment-attachment.update_property' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/business_log/logs: | |
| get: | |
| operationId: getLogCollection | |
| tags: | |
| - Log | |
| responses: | |
| '200': | |
| description: Log collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse.jsonld-business_log.list_business_log.collection.get | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse-business_log.list_business_log.collection.get | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse-business_log.list_business_log.collection.get | |
| summary: Retrieves the collection of Log resources. | |
| description: Retrieves the collection of Log resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[dateCreated] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: dictionaryKey | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dictionaryKey[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: userId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: userId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/business_log/logs/{id}: | |
| get: | |
| operationId: getLogItem | |
| tags: | |
| - Log | |
| responses: | |
| '200': | |
| description: Log resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse.jsonld-business_log.view_business_log.item.get | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse-business_log.view_business_log.item.get | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Log.LogResponse-business_log.view_business_log.item.get | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Log resource. | |
| description: Retrieves a Log resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/comment/comments: | |
| get: | |
| operationId: getCommentCollection | |
| tags: | |
| - Comment | |
| responses: | |
| '200': | |
| description: Comment collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Comment.CommentResponse.jsonld-comment.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.list' | |
| summary: Retrieves the collection of Comment resources. | |
| description: Retrieves the collection of Comment resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[authorId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[resourceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: authorId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: authorId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postCommentCollection | |
| tags: | |
| - Comment | |
| responses: | |
| '201': | |
| description: Comment resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Comment.CommentResponse.jsonld-comment.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| links: | |
| GetCommentItem: | |
| operationId: getCommentItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/comment/comments/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Comment resource. | |
| description: Creates a Comment resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Comment resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Comment.jsonld-comment.create' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Comment-comment.create' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Comment-comment.create' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/comment/comments/resource/{id}: | |
| get: | |
| operationId: get_comments_for_resource_idCommentCollection | |
| tags: | |
| - Comment | |
| responses: | |
| '200': | |
| description: Comment collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Comment.CommentResponse.jsonld-comment.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.list' | |
| summary: Retrieves the collection of Comment resources. | |
| description: Retrieves the collection of Comment resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[authorId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[resourceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: authorId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: authorId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/comment/comments/{id}: | |
| get: | |
| operationId: getCommentItem | |
| tags: | |
| - Comment | |
| responses: | |
| '200': | |
| description: Comment resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Comment.CommentResponse.jsonld-comment.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Comment resource. | |
| description: Retrieves a Comment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putCommentItem | |
| tags: | |
| - Comment | |
| responses: | |
| '200': | |
| description: Comment resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Comment.CommentResponse.jsonld-comment.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Comment.CommentResponse-comment.view' | |
| links: | |
| GetCommentItem: | |
| operationId: getCommentItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/comment/comments/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Comment resource. | |
| description: Replaces the Comment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Comment resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Comment.jsonld-comment.update' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Comment-comment.update' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Comment-comment.update' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteCommentItem | |
| tags: | |
| - Comment | |
| responses: | |
| '204': | |
| description: Comment resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Comment resource. | |
| description: Removes the Comment resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/contact/contacts: | |
| get: | |
| operationId: getContactCollection | |
| tags: | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Contact.jsonld-contact.list_contact.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| summary: Retrieves the collection of Contact resources. | |
| description: Retrieves the collection of Contact resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[firstName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[lastName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[email] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[phoneNumber] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[jobTitle] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: firstName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: jobTitle | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postContactCollection | |
| tags: | |
| - Contact | |
| responses: | |
| '201': | |
| description: Contact resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Contact.jsonld-contact.list_contact.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| links: | |
| GetContactItem: | |
| operationId: getContactItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/contact/contacts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Contact resource. | |
| description: Creates a Contact resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Contact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Contact.jsonld-contact.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/contact/contacts/export: | |
| get: | |
| operationId: exportContactCollection | |
| tags: | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Contact.ContactExportResponse.jsonld-contact.list_contact.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Contact.ContactExportResponse-contact.list_contact.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Contact.ContactExportResponse-contact.list_contact.view | |
| summary: Retrieves the collection of Contact resources. | |
| description: Retrieves the collection of Contact resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[firstName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[lastName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[email] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[phoneNumber] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[jobTitle] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: firstName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: jobTitle | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/contact/contacts/{id}: | |
| get: | |
| operationId: getContactItem | |
| tags: | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Contact.jsonld-contact.list_contact.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Contact resource. | |
| description: Retrieves a Contact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putContactItem | |
| tags: | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Contact.jsonld-contact.list_contact.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.list_contact.view' | |
| links: | |
| GetContactItem: | |
| operationId: getContactItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/contact/contacts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Contact resource. | |
| description: Replaces the Contact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Contact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Contact.jsonld-contact.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Contact-contact.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteContactItem | |
| tags: | |
| - Contact | |
| responses: | |
| '204': | |
| description: Contact resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Contact resource. | |
| description: Removes the Contact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/contact/contacts/{id}/client_contacts: | |
| get: | |
| operationId: api_contacts_client_contacts_get_subresourceContactSubresource | |
| tags: | |
| - ClientContact | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact' | |
| summary: Retrieves a Contact resource. | |
| description: Retrieves a Contact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Contact identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: client | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: client[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact.firstName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.lastName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.jobTitle | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/contact/contacts/{id}/site_contacts: | |
| get: | |
| operationId: api_contacts_site_contacts_get_subresourceContactSubresource | |
| tags: | |
| - SiteContact | |
| - Contact | |
| responses: | |
| '200': | |
| description: Contact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/SiteContact.SiteContactDetailResponse.jsonld-site_contact.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/SiteContact.SiteContactDetailResponse-site_contact.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/SiteContact.SiteContactDetailResponse-site_contact.view | |
| summary: Retrieves a Contact resource. | |
| description: Retrieves a Contact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Contact identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[contact.firstName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[contact.lastName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[contact.email] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[contact.phoneNumber] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact.firstName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.lastName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/customer/customers: | |
| get: | |
| operationId: getCustomerCollection | |
| tags: | |
| - Customer | |
| responses: | |
| '200': | |
| description: Customer collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Customer-customer.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Customer-customer.list' | |
| summary: Retrieves the collection of Customer resources. | |
| description: Retrieves the collection of Customer resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postCustomerCollection | |
| tags: | |
| - Customer | |
| responses: | |
| '201': | |
| description: Customer resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| links: | |
| GetCustomerItem: | |
| operationId: getCustomerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/customer/customers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Customer resource. | |
| description: Creates a Customer resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Customer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/customer/customers/{id}: | |
| get: | |
| operationId: getCustomerItem | |
| tags: | |
| - Customer | |
| responses: | |
| '200': | |
| description: Customer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Customer resource. | |
| description: Retrieves a Customer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putCustomerItem | |
| tags: | |
| - Customer | |
| responses: | |
| '200': | |
| description: Customer resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.view' | |
| links: | |
| GetCustomerItem: | |
| operationId: getCustomerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/customer/customers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Customer resource. | |
| description: Replaces the Customer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Customer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Customer.jsonld-customer.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Customer-customer.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteCustomerItem | |
| tags: | |
| - Customer | |
| responses: | |
| '204': | |
| description: Customer resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Customer resource. | |
| description: Removes the Customer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/alarms: | |
| post: | |
| operationId: alarmsChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/chargers_utilization: | |
| post: | |
| operationId: chargers_utilizationChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/charging_fee: | |
| post: | |
| operationId: charging_feeChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/charging_sessions: | |
| post: | |
| operationId: charger_sessionsChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/energy_consumption: | |
| post: | |
| operationId: energy_consumptionChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/tasks: | |
| post: | |
| operationId: tasksChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/chart/uptime: | |
| post: | |
| operationId: uptimeChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '201': | |
| description: Chart resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Chart resource. | |
| description: Creates a Chart resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/charts: | |
| get: | |
| operationId: getChartCollection | |
| tags: | |
| - Chart | |
| responses: | |
| '200': | |
| description: Chart collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| summary: Retrieves the collection of Chart resources. | |
| description: Retrieves the collection of Chart resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/dashboard/charts/{id}: | |
| get: | |
| operationId: getChartItem | |
| tags: | |
| - Chart | |
| responses: | |
| '200': | |
| description: Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Chart resource. | |
| description: Retrieves a Chart resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putChartItem | |
| tags: | |
| - Chart | |
| responses: | |
| '200': | |
| description: Chart resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Chart resource. | |
| description: Replaces the Chart resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Chart resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Chart.SiteDailyChartRequest.jsonld-graph.post | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteChartItem | |
| tags: | |
| - Chart | |
| responses: | |
| '204': | |
| description: Chart resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Chart resource. | |
| description: Removes the Chart resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchChartItem | |
| tags: | |
| - Chart | |
| responses: | |
| '200': | |
| description: Chart resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart.jsonld-graph.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Chart.TwoDimensionChart-graph.view' | |
| links: | |
| GetChartItem: | |
| operationId: getChartItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/dashboard/charts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the Chart resource. | |
| description: Updates the Chart resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Chart resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: '#/components/schemas/Chart.SiteDailyChartRequest-graph.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/adapter_commands: | |
| get: | |
| operationId: getAdapterCommandCollection | |
| tags: | |
| - AdapterCommand | |
| responses: | |
| '200': | |
| description: AdapterCommand collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AdapterCommand.jsonld-adapter_command.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AdapterCommand-adapter_command.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AdapterCommand-adapter_command.list' | |
| summary: Retrieves the collection of AdapterCommand resources. | |
| description: Retrieves the collection of AdapterCommand resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[coolOff] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[parallel] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: adapter | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: adapter[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: command | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: command[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: coolOff | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: coolOff[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: parallel | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/adapter_commands/{id}: | |
| get: | |
| operationId: getAdapterCommandItem | |
| tags: | |
| - AdapterCommand | |
| responses: | |
| '200': | |
| description: AdapterCommand resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AdapterCommand.jsonld-adapter_command.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AdapterCommand-adapter_command.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AdapterCommand-adapter_command.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a AdapterCommand resource. | |
| description: Retrieves a AdapterCommand resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/adapters: | |
| get: | |
| operationId: getAdapterCollection | |
| tags: | |
| - Adapter | |
| responses: | |
| '200': | |
| description: Adapter collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Adapter.jsonld-adapter.list_device.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Adapter-adapter.list_device.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Adapter-adapter.list_device.view' | |
| summary: Retrieves the collection of Adapter resources. | |
| description: Retrieves the collection of Adapter resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/adapters/{id}: | |
| get: | |
| operationId: getAdapterItem | |
| tags: | |
| - Adapter | |
| responses: | |
| '200': | |
| description: Adapter resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Adapter.jsonld-adapter.view_device.list' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Adapter-adapter.view_device.list' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Adapter-adapter.view_device.list' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Adapter resource. | |
| description: Retrieves a Adapter resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/adapters/{id}/health: | |
| get: | |
| operationId: adapter_healthAdapterItem | |
| tags: | |
| - Adapter | |
| responses: | |
| '200': | |
| description: Adapter resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Adapter.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Adapter' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Adapter' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Adapter resource. | |
| description: Retrieves a Adapter resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_alarm_types: | |
| get: | |
| operationId: getAssetAlarmTypeCollection | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '200': | |
| description: AssetAlarmType collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.list' | |
| summary: Retrieves the collection of AssetAlarmType resources. | |
| description: Retrieves the collection of AssetAlarmType resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[severity] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[initialPriority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[assetFirmware] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: assetFirmware | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAssetAlarmTypeCollection | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '201': | |
| description: AssetAlarmType resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| links: | |
| GetAssetAlarmTypeItem: | |
| operationId: getAssetAlarmTypeItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_alarm_types/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a AssetAlarmType resource. | |
| description: Creates a AssetAlarmType resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new AssetAlarmType resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_alarm_types/export: | |
| get: | |
| operationId: exportAssetAlarmTypeCollection | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '200': | |
| description: AssetAlarmType collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.AssetAlarmTypeExportResponse.jsonld | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.AssetAlarmTypeExportResponse | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.AssetAlarmTypeExportResponse | |
| summary: Retrieves the collection of AssetAlarmType resources. | |
| description: Retrieves the collection of AssetAlarmType resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[severity] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[initialPriority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[assetFirmware] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: assetFirmware | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_alarm_types/{id}: | |
| get: | |
| operationId: getAssetAlarmTypeItem | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '200': | |
| description: AssetAlarmType resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a AssetAlarmType resource. | |
| description: Retrieves a AssetAlarmType resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putAssetAlarmTypeItem | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '200': | |
| description: AssetAlarmType resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| links: | |
| GetAssetAlarmTypeItem: | |
| operationId: getAssetAlarmTypeItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_alarm_types/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the AssetAlarmType resource. | |
| description: Replaces the AssetAlarmType resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated AssetAlarmType resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteAssetAlarmTypeItem | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '204': | |
| description: AssetAlarmType resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the AssetAlarmType resource. | |
| description: Removes the AssetAlarmType resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchAssetAlarmTypeItem | |
| tags: | |
| - AssetAlarmType | |
| responses: | |
| '200': | |
| description: AssetAlarmType resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetAlarmType.jsonld-asset_alarm_type.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.view' | |
| links: | |
| GetAssetAlarmTypeItem: | |
| operationId: getAssetAlarmTypeItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_alarm_types/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the AssetAlarmType resource. | |
| description: Updates the AssetAlarmType resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated AssetAlarmType resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: '#/components/schemas/AssetAlarmType-asset_alarm_type.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_firmware: | |
| get: | |
| operationId: getAssetFirmwareCollection | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '200': | |
| description: AssetFirmware collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.jsonld-asset.firmware.list_asset.firmware.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| summary: Retrieves the collection of AssetFirmware resources. | |
| description: Retrieves the collection of AssetFirmware resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[version] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: version | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: version[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: updatableVersions | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatableVersions[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: deepObject | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAssetFirmwareCollection | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '201': | |
| description: AssetFirmware resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.jsonld-asset.firmware.list_asset.firmware.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| links: | |
| GetAssetFirmwareItem: | |
| operationId: getAssetFirmwareItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_firmware/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a AssetFirmware resource. | |
| description: Creates a AssetFirmware resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new AssetFirmware resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware.jsonld-asset.firmware.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware-asset.firmware.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware-asset.firmware.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_firmware/{id}: | |
| get: | |
| operationId: getAssetFirmwareItem | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '200': | |
| description: AssetFirmware resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.jsonld-asset.firmware.list_asset.firmware.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a AssetFirmware resource. | |
| description: Retrieves a AssetFirmware resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putAssetFirmwareItem | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '200': | |
| description: AssetFirmware resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.jsonld-asset.firmware.list_asset.firmware.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| links: | |
| GetAssetFirmwareItem: | |
| operationId: getAssetFirmwareItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_firmware/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the AssetFirmware resource. | |
| description: Replaces the AssetFirmware resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated AssetFirmware resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware.jsonld-asset.firmware.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware-asset.firmware.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AssetFirmware-asset.firmware.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteAssetFirmwareItem | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '204': | |
| description: AssetFirmware resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the AssetFirmware resource. | |
| description: Removes the AssetFirmware resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/asset_firmware/{id}/upload_firmware: | |
| post: | |
| operationId: upload_firmwareAssetFirmwareItem | |
| tags: | |
| - AssetFirmware | |
| responses: | |
| '201': | |
| description: AssetFirmware resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.jsonld-asset.firmware.list_asset.firmware.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware-asset.firmware.list_asset.firmware.view | |
| links: | |
| GetAssetFirmwareItem: | |
| operationId: getAssetFirmwareItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/asset_firmware/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a AssetFirmware resource. | |
| description: Creates a AssetFirmware resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new AssetFirmware resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.UploadAssetFirmware.jsonld-asset.firmware.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.UploadAssetFirmware-asset.firmware.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AssetFirmware.UploadAssetFirmware-asset.firmware.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/assets: | |
| get: | |
| operationId: getAssetCollection | |
| tags: | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse.jsonld-asset.list_image.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.list_image.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.list_image.view | |
| summary: Retrieves the collection of Asset resources. | |
| description: Retrieves the collection of Asset resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[image.id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[controlType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedDrop] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedRise] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[recoveryTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reactionTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[maxDispatchTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: controlType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedRise | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedRise[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: recoveryTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: recoveryTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reactionTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: reactionTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: maxDispatchTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxDispatchTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connectors.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connectors.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAssetCollection | |
| tags: | |
| - Asset | |
| responses: | |
| '201': | |
| description: Asset resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse.jsonld-asset.view_image.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| links: | |
| GetAssetItem: | |
| operationId: getAssetItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/assets/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Asset resource. | |
| description: Creates a Asset resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Asset resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Asset.jsonld-asset.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Asset-asset.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Asset-asset.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/assets/export: | |
| get: | |
| operationId: exportAssetCollection | |
| tags: | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetExportResponse.jsonld-asset.export | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Asset.AssetExportResponse-asset.export' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Asset.AssetExportResponse-asset.export' | |
| summary: Retrieves the collection of Asset resources. | |
| description: Retrieves the collection of Asset resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[image.id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[controlType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedDrop] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedRise] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[recoveryTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reactionTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[maxDispatchTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: controlType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedRise | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedRise[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: recoveryTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: recoveryTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reactionTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: reactionTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: maxDispatchTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxDispatchTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connectors.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connectors.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/assets/{id}: | |
| get: | |
| operationId: getAssetItem | |
| tags: | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse.jsonld-asset.view_image.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Asset resource. | |
| description: Retrieves a Asset resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putAssetItem | |
| tags: | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse.jsonld-asset.view_image.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| links: | |
| GetAssetItem: | |
| operationId: getAssetItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/assets/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Asset resource. | |
| description: Replaces the Asset resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Asset resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Asset.jsonld-asset.edit' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Asset-asset.edit' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Asset-asset.edit' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteAssetItem | |
| tags: | |
| - Asset | |
| responses: | |
| '204': | |
| description: Asset resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Asset resource. | |
| description: Removes the Asset resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchAssetItem | |
| tags: | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse.jsonld-asset.view_image.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Asset.AssetDetailResponse-asset.view_image.view | |
| links: | |
| GetAssetItem: | |
| operationId: getAssetItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/assets/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the Asset resource. | |
| description: Updates the Asset resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Asset resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: '#/components/schemas/Asset-asset.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/assets/{id}/alarm_types: | |
| get: | |
| operationId: api_assets_alarm_types_get_subresourceAssetSubresource | |
| tags: | |
| - AssetAlarmType | |
| - Asset | |
| responses: | |
| '200': | |
| description: Asset resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetAlarmType.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetAlarmType' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AssetAlarmType' | |
| summary: Retrieves a Asset resource. | |
| description: Retrieves a Asset resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Asset identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[severity] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[initialPriority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[assetFirmware] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: assetFirmware | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charge_points/export: | |
| get: | |
| operationId: exportChargerCollection | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerExportResponse.jsonld | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger.ChargerExportResponse' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger.ChargerExportResponse' | |
| summary: Retrieves the collection of Charger resources. | |
| description: Retrieves the collection of Charger resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.asset.manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charge_points/statistics: | |
| get: | |
| operationId: charge_points_statisticsChargerCollection | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargePointsStatisticsResponse.jsonld | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger.ChargePointsStatisticsResponse' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger.ChargePointsStatisticsResponse' | |
| summary: Retrieves the collection of Charger resources. | |
| description: Retrieves the collection of Charger resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.asset.manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger/{id}/change_type: | |
| put: | |
| operationId: put_charger_typeChargerItem | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Charger.jsonld-charger.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Charger-charger.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Charger-charger.view' | |
| links: | |
| GetChargerItem: | |
| operationId: getChargerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/chargers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Charger resource. | |
| description: Replaces the Charger resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Charger resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChangeChargerType.jsonld-charger.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Charger.ChangeChargerType-charger.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Charger.ChangeChargerType-charger.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger/{id}/connectors/{connectorIdentifier}: | |
| put: | |
| operationId: put_charger_connector_nameChargerItem | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Charger.jsonld-charger.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Charger-charger.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Charger-charger.view' | |
| links: | |
| GetChargerItem: | |
| operationId: getChargerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/chargers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Charger resource. | |
| description: Replaces the Charger resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: '' | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| name: | |
| type: string | |
| example: | |
| name: Mr. Rabbit | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger/{id}/connectors/{connectorIdentifier}/tariff_assigns: | |
| post: | |
| operationId: post_charger_connector_tariff_assignsChargerItem | |
| tags: | |
| - Charger | |
| responses: | |
| '204': | |
| description: Charger resource created | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetChargerItem: | |
| operationId: getChargerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/chargers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Assign tariffs with priority to charger connector | |
| description: >- | |
| Assign tariffs with priority to charger connector and remove old | |
| assigned | |
| parameters: | |
| - name: id | |
| in: path | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: [] | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: connectorIdentifier | |
| in: path | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: [] | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Charger resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.AssignTariffsToConnector.jsonld-charger.connector.tariff_assign.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.AssignTariffsToConnector-charger.connector.tariff_assign.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.AssignTariffsToConnector-charger.connector.tariff_assign.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger_sessions: | |
| get: | |
| operationId: getChargerSessionCollection | |
| tags: | |
| - ChargerSession | |
| responses: | |
| '200': | |
| description: ChargerSession collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionResponse.jsonld-charging_session.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionResponse-charging_session.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionResponse-charging_session.list | |
| summary: Retrieves the collection of ChargerSession resources. | |
| description: Retrieves the collection of ChargerSession resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.deviceIdentifier[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: charger.device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.externalDeviceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: charger.device.id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tokenId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: tokenId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: charger.device.servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: charger.id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[charger.device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[charger.device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[charger.device.servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[startAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[endAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[cdr.totalCost] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[transactionId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.device.servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[connectorIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reason] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[meterStart] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[meterEnd] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[tokenId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[tokenType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[organizationId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[deletedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger_sessions/export: | |
| get: | |
| operationId: charger_session_exportChargerSessionCollection | |
| tags: | |
| - ChargerSession | |
| responses: | |
| '200': | |
| description: ChargerSession collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargerSessionExportResponse.jsonld | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargerSessionExportResponse | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargerSessionExportResponse | |
| summary: Retrieves the collection of ChargerSession resources. | |
| description: Retrieves the collection of ChargerSession resources. | |
| parameters: | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger_sessions/statistics: | |
| get: | |
| operationId: charger_session_statisticsChargerSessionCollection | |
| tags: | |
| - ChargerSession | |
| responses: | |
| '200': | |
| description: ChargerSession collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionStatisticsResponse.jsonld | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionStatisticsResponse | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionStatisticsResponse | |
| summary: Retrieves the collection of ChargerSession resources. | |
| description: Retrieves the collection of ChargerSession resources. | |
| parameters: | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger_sessions/{id}: | |
| get: | |
| operationId: getChargerSessionItem | |
| tags: | |
| - ChargerSession | |
| responses: | |
| '200': | |
| description: ChargerSession resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.jsonld-charging_session.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargerSession-charging_session.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargerSession-charging_session.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargerSession resource. | |
| description: Retrieves a ChargerSession resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charger_sessions/{id}/details: | |
| get: | |
| operationId: session_detailsChargerSessionItem | |
| tags: | |
| - ChargerSession | |
| responses: | |
| '200': | |
| description: ChargerSession resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionDetailsResponse.jsonld-charging_session.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionDetailsResponse-charging_session.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargerSession.ChargingSessionDetailsResponse-charging_session.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargerSession resource. | |
| description: Retrieves a ChargerSession resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/chargers: | |
| get: | |
| operationId: getChargerCollection | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger.jsonld-charger.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger-charger.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Charger-charger.list' | |
| summary: Retrieves the collection of Charger resources. | |
| description: Retrieves the collection of Charger resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.asset.manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/chargers/ev/dashboard: | |
| get: | |
| operationId: ev_dashboardChargerCollection | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerDashboardResponse.jsonld-charger_dashboard.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerDashboardResponse-charger_dashboard.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerDashboardResponse-charger_dashboard.list | |
| summary: Retrieves the collection of Charger resources. | |
| description: Retrieves the collection of Charger resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.asset.manufacturer | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.manufacturer[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.asset.manufacturer.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/chargers/{id}: | |
| get: | |
| operationId: getChargerItem | |
| tags: | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerItemResponse.jsonld-charger.view_charger.item.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerItemResponse-charger.view_charger.item.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerItemResponse-charger.view_charger.item.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Charger resource. | |
| description: Retrieves a Charger resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/chargers/{id}/connectors: | |
| get: | |
| operationId: api_chargers_connectors_get_subresourceChargerSubresource | |
| tags: | |
| - ChargerConnector | |
| - Charger | |
| responses: | |
| '200': | |
| description: Charger resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ChargerConnector.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ChargerConnector' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ChargerConnector' | |
| summary: Retrieves a Charger resource. | |
| description: Retrieves a Charger resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Charger identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/charging_sessions: | |
| get: | |
| operationId: getChargingSessionCollection | |
| tags: | |
| - ChargingSession | |
| responses: | |
| '200': | |
| description: ChargingSession collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSession.jsonld-charging_session.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.list' | |
| summary: Retrieves the collection of ChargingSession resources. | |
| description: Retrieves the collection of ChargingSession resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[startAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[endAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connector | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connector[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reason | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: true | |
| parameters: [] | |
| /api/core/protected/v1/device/charging_sessions/{id}: | |
| get: | |
| operationId: getChargingSessionItem | |
| tags: | |
| - ChargingSession | |
| responses: | |
| '200': | |
| description: ChargingSession resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSession.jsonld-charging_session.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargingSession resource. | |
| description: Retrieves a ChargingSession resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: true | |
| put: | |
| operationId: putChargingSessionItem | |
| tags: | |
| - ChargingSession | |
| responses: | |
| '200': | |
| description: ChargingSession resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSession.jsonld-charging_session.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession-charging_session.view' | |
| links: | |
| GetChargingSessionItem: | |
| operationId: getChargingSessionItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/charging_sessions/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ChargingSession resource. | |
| description: Replaces the ChargingSession resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ChargingSession resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSession' | |
| required: true | |
| deprecated: true | |
| delete: | |
| operationId: deleteChargingSessionItem | |
| tags: | |
| - ChargingSession | |
| responses: | |
| '204': | |
| description: ChargingSession resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the ChargingSession resource. | |
| description: Removes the ChargingSession resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: true | |
| parameters: [] | |
| /api/core/protected/v1/device/commands: | |
| get: | |
| operationId: getCommandCollection | |
| tags: | |
| - Command | |
| responses: | |
| '200': | |
| description: Command collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Command.jsonld-command.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Command-command.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Command-command.list' | |
| summary: Retrieves the collection of Command resources. | |
| description: Retrieves the collection of Command resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/commands/{id}: | |
| get: | |
| operationId: getCommandItem | |
| tags: | |
| - Command | |
| responses: | |
| '200': | |
| description: Command resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Command.jsonld-command.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Command-command.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Command-command.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Command resource. | |
| description: Retrieves a Command resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connectivities: | |
| get: | |
| operationId: getConnectivityCollection | |
| tags: | |
| - Connectivity | |
| responses: | |
| '200': | |
| description: Connectivity collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Connectivity.jsonld-connectivity.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connectivity-connectivity.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connectivity-connectivity.list' | |
| summary: Retrieves the collection of Connectivity resources. | |
| description: Retrieves the collection of Connectivity resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[online] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[lastSeenDateTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastSeenDateTime[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastSeenDateTime[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastSeenDateTime[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: lastSeenDateTime[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: online | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connectivities/{id}: | |
| get: | |
| operationId: getConnectivityItem | |
| tags: | |
| - Connectivity | |
| responses: | |
| '200': | |
| description: Connectivity resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connectivity.jsonld-connectivity.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connectivity-connectivity.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connectivity-connectivity.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Connectivity resource. | |
| description: Retrieves a Connectivity resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connector_statuses: | |
| get: | |
| operationId: getConnectorStatusCollection | |
| tags: | |
| - ConnectorStatus | |
| responses: | |
| '200': | |
| description: ConnectorStatus collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ConnectorStatus.jsonld-connector_status.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ConnectorStatus-connector_status.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ConnectorStatus-connector_status.list' | |
| summary: Retrieves the collection of ConnectorStatus resources. | |
| description: Retrieves the collection of ConnectorStatus resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: charger | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connector | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connector[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connector_statuses/{id}: | |
| get: | |
| operationId: getConnectorStatusItem | |
| tags: | |
| - ConnectorStatus | |
| responses: | |
| '200': | |
| description: ConnectorStatus resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ConnectorStatus.jsonld-connector_status.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ConnectorStatus-connector_status.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ConnectorStatus-connector_status.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ConnectorStatus resource. | |
| description: Retrieves a ConnectorStatus resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connector_types: | |
| get: | |
| operationId: get_connector_typesConnectorCollection | |
| tags: | |
| - Connector | |
| responses: | |
| '200': | |
| description: Connector collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector' | |
| summary: Retrieves the collection of Connector resources. | |
| description: Retrieves the collection of Connector resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[connectorIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connectors: | |
| get: | |
| operationId: getConnectorCollection | |
| tags: | |
| - Connector | |
| responses: | |
| '200': | |
| description: Connector collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector-connector.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Connector-connector.list' | |
| summary: Retrieves the collection of Connector resources. | |
| description: Retrieves the collection of Connector resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[connectorIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postConnectorCollection | |
| tags: | |
| - Connector | |
| responses: | |
| '201': | |
| description: Connector resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| links: | |
| GetConnectorItem: | |
| operationId: getConnectorItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/connectors/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Connector resource. | |
| description: Creates a Connector resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Connector resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/connectors/{id}: | |
| get: | |
| operationId: getConnectorItem | |
| tags: | |
| - Connector | |
| responses: | |
| '200': | |
| description: Connector resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Connector resource. | |
| description: Retrieves a Connector resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putConnectorItem | |
| tags: | |
| - Connector | |
| responses: | |
| '200': | |
| description: Connector resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.view' | |
| links: | |
| GetConnectorItem: | |
| operationId: getConnectorItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/connectors/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Connector resource. | |
| description: Replaces the Connector resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Connector resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Connector.jsonld-connector.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Connector-connector.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteConnectorItem | |
| tags: | |
| - Connector | |
| responses: | |
| '204': | |
| description: Connector resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Connector resource. | |
| description: Removes the Connector resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_commands: | |
| get: | |
| operationId: getDeviceCommandCollection | |
| tags: | |
| - DeviceCommand | |
| responses: | |
| '200': | |
| description: DeviceCommand collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.jsonld-device_command.list_device_command.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand-device_command.list_device_command.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand-device_command.list_device_command.view | |
| summary: Retrieves the collection of DeviceCommand resources. | |
| description: Retrieves the collection of DeviceCommand resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[requestId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[operation] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[dateCreated] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[dateUpdated] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: operation | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: requestId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateCreated[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateCreated[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateCreated[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateCreated[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateUpdated[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateUpdated[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateUpdated[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dateUpdated[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_commands/{requestId}: | |
| get: | |
| operationId: getDeviceCommandItem | |
| tags: | |
| - DeviceCommand | |
| responses: | |
| '200': | |
| description: DeviceCommand resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.jsonld-device_command.list_device_command.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand-device_command.list_device_command.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand-device_command.list_device_command.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a DeviceCommand resource. | |
| description: Retrieves a DeviceCommand resource. | |
| parameters: | |
| - name: requestId | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_commands/{requestId}/cancel: | |
| post: | |
| operationId: cancel_commandDeviceCommandItem | |
| tags: | |
| - DeviceCommand | |
| responses: | |
| '201': | |
| description: DeviceCommand resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse.jsonld-device_command.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse-device_command.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse-device_command.view | |
| links: | |
| GetDeviceCommandItem: | |
| operationId: getDeviceCommandItem | |
| parameters: | |
| requestId: $response.body#/requestId | |
| description: >- | |
| The `requestId` value returned in the response can be used as | |
| the `requestId` parameter in `GET | |
| /api/core/protected/v1/device/device_commands/{requestId}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a DeviceCommand resource. | |
| description: Creates a DeviceCommand resource. | |
| parameters: | |
| - name: requestId | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new DeviceCommand resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_commands/{requestId}/retry: | |
| post: | |
| operationId: retry_commandDeviceCommandItem | |
| tags: | |
| - DeviceCommand | |
| responses: | |
| '201': | |
| description: DeviceCommand resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse.jsonld-device_command.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse-device_command.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceCommand.GenericResponse-device_command.view | |
| links: | |
| GetDeviceCommandItem: | |
| operationId: getDeviceCommandItem | |
| parameters: | |
| requestId: $response.body#/requestId | |
| description: >- | |
| The `requestId` value returned in the response can be used as | |
| the `requestId` parameter in `GET | |
| /api/core/protected/v1/device/device_commands/{requestId}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a DeviceCommand resource. | |
| description: Creates a DeviceCommand resource. | |
| parameters: | |
| - name: requestId | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new DeviceCommand resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/DeviceCommand' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_configuration_revisions: | |
| get: | |
| operationId: getDeviceConfigurationRevisionCollection | |
| tags: | |
| - DeviceConfigurationRevision | |
| responses: | |
| '200': | |
| description: DeviceConfigurationRevision collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision.jsonld-device_configuration_revision.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision-device_configuration_revision.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision-device_configuration_revision.list | |
| summary: Retrieves the collection of DeviceConfigurationRevision resources. | |
| description: Retrieves the collection of DeviceConfigurationRevision resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceConfiguration | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceConfiguration[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_configuration_revisions/{id}: | |
| get: | |
| operationId: getDeviceConfigurationRevisionItem | |
| tags: | |
| - DeviceConfigurationRevision | |
| responses: | |
| '200': | |
| description: DeviceConfigurationRevision resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision.jsonld-device_configuration_revision.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision-device_configuration_revision.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfigurationRevision-device_configuration_revision.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a DeviceConfigurationRevision resource. | |
| description: Retrieves a DeviceConfigurationRevision resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_configurations: | |
| get: | |
| operationId: getDeviceConfigurationCollection | |
| tags: | |
| - DeviceConfiguration | |
| responses: | |
| '200': | |
| description: DeviceConfiguration collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration.jsonld-device_configuration.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration-device_configuration.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration-device_configuration.list | |
| summary: Retrieves the collection of DeviceConfiguration resources. | |
| description: Retrieves the collection of DeviceConfiguration resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/device_configurations/{id}: | |
| get: | |
| operationId: getDeviceConfigurationItem | |
| tags: | |
| - DeviceConfiguration | |
| responses: | |
| '200': | |
| description: DeviceConfiguration resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration.jsonld-device_configuration.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration-device_configuration.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/DeviceConfiguration-device_configuration.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a DeviceConfiguration resource. | |
| description: Retrieves a DeviceConfiguration resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices: | |
| get: | |
| operationId: getDeviceCollection | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.jsonld-device.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device-device.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device-device.list' | |
| summary: Retrieves the collection of Device resources. | |
| description: Retrieves the collection of Device resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[serialNumber] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[firmwareVersion] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[controlType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedDrop] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedRise] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[recoveryTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reactionTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[maxDispatchTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[servicePoint.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: serialNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: firmwareVersion | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: controlType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: controlType[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedDrop | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedRise | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedRise[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: recoveryTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: recoveryTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reactionTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: reactionTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: maxDispatchTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxDispatchTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: asset.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: asset.model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.connectors.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.connectors.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: organizationId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: organizationId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: servicePoint[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postDeviceCollection | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld-device.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld-device.post' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.post' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.post' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/bulk/assign_to_organization: | |
| put: | |
| operationId: bulk_assign_devices_to_organizationDeviceCollection | |
| tags: | |
| - Device | |
| responses: | |
| '202': | |
| description: Device resource updated | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Device resource. | |
| description: Replaces the Device resource. | |
| parameters: [] | |
| requestBody: | |
| description: The updated Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Device.AssignDevicesToOrganization.jsonld-device.write | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Device.AssignDevicesToOrganization-device.write | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Device.AssignDevicesToOrganization-device.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/bulk/assign_to_site: | |
| put: | |
| operationId: bulk_assign_devices_to_siteDeviceCollection | |
| tags: | |
| - Device | |
| responses: | |
| '202': | |
| description: Device resource updated | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Device resource. | |
| description: Replaces the Device resource. | |
| parameters: [] | |
| requestBody: | |
| description: The updated Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Device.AssignDevicesToSite.jsonld-device.write | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.AssignDevicesToSite-device.write' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.AssignDevicesToSite-device.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/export: | |
| get: | |
| operationId: exportDeviceCollection | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.DeviceExportResponse.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.DeviceExportResponse' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Device.DeviceExportResponse' | |
| summary: Retrieves the collection of Device resources. | |
| description: Retrieves the collection of Device resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[serialNumber] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[firmwareVersion] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[controlType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedDrop] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[expectedRise] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[recoveryTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reactionTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[maxDispatchTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.model] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[asset.type] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[servicePoint.site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[servicePoint.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: serialNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: firmwareVersion | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: controlType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: controlType[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedDrop | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedDrop[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: expectedRise | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: expectedRise[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: recoveryTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: recoveryTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reactionTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: reactionTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: maxDispatchTime | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxDispatchTime[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: asset.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: asset.model | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.connectors.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: asset.connectors.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: organizationId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: organizationId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: servicePoint[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: servicePoint.site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoint.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}: | |
| get: | |
| operationId: getDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld-device.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Device resource. | |
| description: Retrieves a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld-device.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.view' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Device resource. | |
| description: Replaces the Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld-device.put' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.put' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device-device.put' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '204': | |
| description: Device resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Device resource. | |
| description: Removes the Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/available_commands: | |
| get: | |
| operationId: get_available_commandsDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.CommandActionResponse.jsonld-device.available_command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.CommandActionResponse-device.available_command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.CommandActionResponse-device.available_command | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Device resource. | |
| description: Retrieves a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/cancel_reservation: | |
| post: | |
| operationId: cancel_reservationDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceCancelReservation.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceCancelReservation-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceCancelReservation-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/change_availability: | |
| post: | |
| operationId: change_availabilityDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceChangeAvailability.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceChangeAvailability-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceChangeAvailability-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/change_configuration: | |
| post: | |
| operationId: change_configurationDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: '' | |
| content: | |
| application/json: | |
| schema: | |
| type: object | |
| properties: | |
| configuration: | |
| type: object | |
| properties: | |
| property_1: | |
| type: string | |
| property_2: | |
| type: string | |
| example: | |
| configuration: | |
| property_1: '10' | |
| property_2: '20' | |
| property_3: '20' | |
| property_4: '20' | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/clear_charging_profile: | |
| post: | |
| operationId: clear_charging_profileDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceClearChargingProfile.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceClearChargingProfile-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceClearChargingProfile-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/get_composite_schedule: | |
| post: | |
| operationId: get_composite_scheduleDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetCompositeSchedule.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetCompositeSchedule-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetCompositeSchedule-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/get_configuration: | |
| post: | |
| operationId: get_configurationDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.GetDeviceConfiguration.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.GetDeviceConfiguration-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.GetDeviceConfiguration-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/get_local_list_version: | |
| post: | |
| operationId: get_local_list_versionDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetLocalListVersion.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetLocalListVersion-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceGetLocalListVersion-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/health: | |
| get: | |
| operationId: healthDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '200': | |
| description: Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.DeviceHealth.jsonld-device.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.DeviceHealth-device.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.DeviceHealth-device.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Device resource. | |
| description: Retrieves a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/registration: | |
| post: | |
| operationId: registrationDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/remote_start_transaction: | |
| post: | |
| operationId: remote_start_transactionDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStartTransaction.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStartTransaction-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStartTransaction-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/remote_stop_transaction: | |
| post: | |
| operationId: remote_stop_transactionDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStopTransaction.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStopTransaction-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceRemoteStopTransaction-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/reserve_now: | |
| post: | |
| operationId: reserve_nowDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceReserveNow.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceReserveNow-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceReserveNow-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/reset: | |
| post: | |
| operationId: resetDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.ResetDeviceRequest.jsonld-device.write.reset | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.ResetDeviceRequest-device.write.reset | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.ResetDeviceRequest-device.write.reset | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/unlock_connector: | |
| post: | |
| operationId: unlock_connectorDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceUnlockConnector.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceUnlockConnector-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.DeviceUnlockConnector-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/devices/{id}/update_firmware: | |
| post: | |
| operationId: update_firmwareDeviceItem | |
| tags: | |
| - Device | |
| responses: | |
| '201': | |
| description: Device resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Device.CommandActionResponse' | |
| links: | |
| GetDeviceItem: | |
| operationId: getDeviceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/devices/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Device resource. | |
| description: Creates a Device resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new Device resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.UpdateDeviceFirmware.jsonld-device.write.command | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.UpdateDeviceFirmware-device.write.command | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Device.UpdateDeviceFirmware-device.write.command | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/ev/authorize: | |
| post: | |
| operationId: authorizationChargerCollection | |
| tags: | |
| - Charger | |
| responses: | |
| '201': | |
| description: Charger resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeResponse.jsonld-charger.authorize | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeResponse-charger.authorize | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeResponse-charger.authorize | |
| links: | |
| GetChargerItem: | |
| operationId: getChargerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/chargers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Charger resource. | |
| description: Creates a Charger resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Charger resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeRequest.jsonld-charger.authorize | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeRequest-charger.authorize | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Charger.ChargerAuthorizeRequest-charger.authorize | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/images: | |
| get: | |
| operationId: getImageCollection | |
| tags: | |
| - Image | |
| responses: | |
| '200': | |
| description: Image collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Image.jsonld-image.view' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Image-image.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Image-image.view' | |
| summary: Retrieves the collection of Image resources. | |
| description: Retrieves the collection of Image resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postImageCollection | |
| tags: | |
| - Image | |
| responses: | |
| '201': | |
| description: Image resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Image.jsonld-image.read.upload' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Image-image.read.upload' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Image-image.read.upload' | |
| links: | |
| GetImageItem: | |
| operationId: getImageItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/device/images/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Image resource. | |
| description: Creates a Image resource. | |
| parameters: [] | |
| requestBody: | |
| description: '' | |
| content: | |
| multipart/form-data: | |
| schema: | |
| type: object | |
| properties: | |
| file: | |
| type: string | |
| format: binary | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/images/{id}: | |
| get: | |
| operationId: getImageItem | |
| tags: | |
| - Image | |
| responses: | |
| '200': | |
| description: Image resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Image.jsonld-image.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Image-image.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Image-image.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Image resource. | |
| description: Retrieves a Image resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/manufacturers: | |
| get: | |
| operationId: getManufacturerCollection | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '200': | |
| description: Manufacturer collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.jsonld-manufacturer.list_manufacturer.assets.count | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.list_manufacturer.assets.count | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.list_manufacturer.assets.count | |
| summary: Retrieves the collection of Manufacturer resources. | |
| description: Retrieves the collection of Manufacturer resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postManufacturerCollection | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '201': | |
| description: Manufacturer resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer.jsonld-manufacturer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| links: | |
| GetManufacturerItem: | |
| operationId: getManufacturerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/manufacturers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Manufacturer resource. | |
| description: Creates a Manufacturer resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Manufacturer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.jsonld-manufacturer.create_manufacturer.update | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.create_manufacturer.update | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.create_manufacturer.update | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/manufacturers/export: | |
| get: | |
| operationId: exportManufacturerCollection | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '200': | |
| description: Manufacturer collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.ManufacturerExportResponse.jsonld-manufacturer.view_manufacturer.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.ManufacturerExportResponse-manufacturer.view_manufacturer.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.ManufacturerExportResponse-manufacturer.view_manufacturer.list | |
| summary: Retrieves the collection of Manufacturer resources. | |
| description: Retrieves the collection of Manufacturer resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/device/manufacturers/{id}: | |
| get: | |
| operationId: getManufacturerItem | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '200': | |
| description: Manufacturer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.jsonld-manufacturer.view_manufacturer.assets.count | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.view_manufacturer.assets.count | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.view_manufacturer.assets.count | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Manufacturer resource. | |
| description: Retrieves a Manufacturer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putManufacturerItem | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '200': | |
| description: Manufacturer resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer.jsonld-manufacturer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| links: | |
| GetManufacturerItem: | |
| operationId: getManufacturerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/manufacturers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Manufacturer resource. | |
| description: Replaces the Manufacturer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Manufacturer resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer.jsonld-manufacturer.create_manufacturer.update | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.create_manufacturer.update | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.create_manufacturer.update | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteManufacturerItem | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '204': | |
| description: Manufacturer resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Manufacturer resource. | |
| description: Removes the Manufacturer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchManufacturerItem | |
| tags: | |
| - Manufacturer | |
| responses: | |
| '200': | |
| description: Manufacturer resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer.jsonld-manufacturer.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Manufacturer-manufacturer.view' | |
| links: | |
| GetManufacturerItem: | |
| operationId: getManufacturerItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/device/manufacturers/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the Manufacturer resource. | |
| description: Updates the Manufacturer resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Manufacturer resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Manufacturer-manufacturer.create_manufacturer.update | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/cards/my: | |
| get: | |
| operationId: my_cardsUserCardCollection | |
| tags: | |
| - UserCard | |
| responses: | |
| '200': | |
| description: UserCard collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserCard.jsonld-ev_user_card.view' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserCard-ev_user_card.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/UserCard-ev_user_card.view' | |
| summary: Retrieves the collection of UserCard resources. | |
| description: Retrieves the collection of UserCard resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/cards/{id}: | |
| get: | |
| operationId: user_cardsUserCardItem | |
| tags: | |
| - UserCard | |
| responses: | |
| '200': | |
| description: UserCard resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/UserCard.jsonld-ev_user_card.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/UserCard-ev_user_card.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/UserCard-ev_user_card.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a UserCard resource. | |
| description: Retrieves a UserCard resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/cdrs: | |
| get: | |
| operationId: getEvCDRCollection | |
| tags: | |
| - EvCDR | |
| responses: | |
| '200': | |
| description: EvCDR collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvCDR.jsonld-ev_cdr.view' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvCDR-ev_cdr.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvCDR-ev_cdr.view' | |
| summary: Retrieves the collection of EvCDR resources. | |
| description: Retrieves the collection of EvCDR resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: session | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: session[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tokenId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: tokenId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: isCredit | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: isCredit[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: boolean | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[startDateTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[endDateTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/cdrs/{id}: | |
| get: | |
| operationId: getEvCDRItem | |
| tags: | |
| - EvCDR | |
| responses: | |
| '200': | |
| description: EvCDR resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvCDR.jsonld-ev_cdr.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvCDR-ev_cdr.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvCDR-ev_cdr.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a EvCDR resource. | |
| description: Retrieves a EvCDR resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charger_connectors/{id}: | |
| get: | |
| operationId: getChargerConnectorItem | |
| tags: | |
| - ChargerConnector | |
| responses: | |
| '200': | |
| description: ChargerConnector resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ChargerConnector.jsonld-connector.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargerConnector-connector.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargerConnector-connector.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargerConnector resource. | |
| description: Retrieves a ChargerConnector resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_profiles: | |
| get: | |
| operationId: getChargingProfileCollection | |
| tags: | |
| - ChargingProfile | |
| responses: | |
| '200': | |
| description: ChargingProfile collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile-ev_charging_profile.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile-ev_charging_profile.list | |
| summary: Retrieves the collection of ChargingProfile resources. | |
| description: Retrieves the collection of ChargingProfile resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connectorId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connectorId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: stackLevel | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: stackLevel[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: chargingProfilePurposeType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: chargingProfileKindType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[stackLevel] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validFrom[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validFrom[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validFrom[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validFrom[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validTo[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validTo[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validTo[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: validTo[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postChargingProfileCollection | |
| tags: | |
| - ChargingProfile | |
| responses: | |
| '201': | |
| description: ChargingProfile resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| links: | |
| GetChargingProfileItem: | |
| operationId: getChargingProfileItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/charging_profiles/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a ChargingProfile resource. | |
| description: Creates a ChargingProfile resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new ChargingProfile resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_profiles/{id}: | |
| get: | |
| operationId: getChargingProfileItem | |
| tags: | |
| - ChargingProfile | |
| responses: | |
| '200': | |
| description: ChargingProfile resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargingProfile resource. | |
| description: Retrieves a ChargingProfile resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putChargingProfileItem | |
| tags: | |
| - ChargingProfile | |
| responses: | |
| '200': | |
| description: ChargingProfile resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.view' | |
| links: | |
| GetChargingProfileItem: | |
| operationId: getChargingProfileItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/charging_profiles/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ChargingProfile resource. | |
| description: Replaces the ChargingProfile resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ChargingProfile resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingProfile.jsonld-ev_charging_profile.update | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.update' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingProfile-ev_charging_profile.update' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteChargingProfileItem | |
| tags: | |
| - ChargingProfile | |
| responses: | |
| '204': | |
| description: ChargingProfile resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the ChargingProfile resource. | |
| description: Removes the ChargingProfile resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_profiles/{id}/charging_schedule: | |
| get: | |
| operationId: >- | |
| api_charging_profiles_charging_schedule_get_subresourceChargingProfileSubresource | |
| tags: | |
| - ChargingSchedule | |
| - ChargingProfile | |
| responses: | |
| '200': | |
| description: ChargingProfile resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule' | |
| summary: Retrieves a ChargingProfile resource. | |
| description: Retrieves a ChargingProfile resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: ChargingProfile identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_schedule_periods: | |
| get: | |
| operationId: getChargingSchedulePeriodCollection | |
| tags: | |
| - ChargingSchedulePeriod | |
| responses: | |
| '200': | |
| description: ChargingSchedulePeriod collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod.jsonld-ev_charging_profile.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.list | |
| summary: Retrieves the collection of ChargingSchedulePeriod resources. | |
| description: Retrieves the collection of ChargingSchedulePeriod resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: chargingSchedule.chargingProfile | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: chargingSchedule.chargingProfile[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_schedule_periods/{id}: | |
| get: | |
| operationId: getChargingSchedulePeriodItem | |
| tags: | |
| - ChargingSchedulePeriod | |
| responses: | |
| '200': | |
| description: ChargingSchedulePeriod resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargingSchedulePeriod resource. | |
| description: Retrieves a ChargingSchedulePeriod resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putChargingSchedulePeriodItem | |
| tags: | |
| - ChargingSchedulePeriod | |
| responses: | |
| '200': | |
| description: ChargingSchedulePeriod resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.view | |
| links: | |
| GetChargingSchedulePeriodItem: | |
| operationId: getChargingSchedulePeriodItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/charging_schedule_periods/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ChargingSchedulePeriod resource. | |
| description: Replaces the ChargingSchedulePeriod resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ChargingSchedulePeriod resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod.jsonld-ev_charging_profile.update | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.update | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedulePeriod-ev_charging_profile.update | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_schedules: | |
| get: | |
| operationId: getChargingScheduleCollection | |
| tags: | |
| - ChargingSchedule | |
| responses: | |
| '200': | |
| description: ChargingSchedule collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule.jsonld-ev_charging_profile.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule-ev_charging_profile.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule-ev_charging_profile.list | |
| summary: Retrieves the collection of ChargingSchedule resources. | |
| description: Retrieves the collection of ChargingSchedule resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: chargingProfile | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: chargingProfile[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: startSchedule[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startSchedule[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startSchedule[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startSchedule[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/charging_schedules/{id}: | |
| get: | |
| operationId: getChargingScheduleItem | |
| tags: | |
| - ChargingSchedule | |
| responses: | |
| '200': | |
| description: ChargingSchedule resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ChargingSchedule resource. | |
| description: Retrieves a ChargingSchedule resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putChargingScheduleItem | |
| tags: | |
| - ChargingSchedule | |
| responses: | |
| '200': | |
| description: ChargingSchedule resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule.jsonld-ev_charging_profile.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.view' | |
| links: | |
| GetChargingScheduleItem: | |
| operationId: getChargingScheduleItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/charging_schedules/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ChargingSchedule resource. | |
| description: Replaces the ChargingSchedule resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ChargingSchedule resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/ChargingSchedule.jsonld-ev_charging_profile.update | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.update' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ChargingSchedule-ev_charging_profile.update' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/ev_tariffs: | |
| get: | |
| operationId: getEvTariffsCollection | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '200': | |
| description: EvTariffs collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvTariffs.jsonld-ev_tariff.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.list' | |
| summary: Retrieves the collection of EvTariffs resources. | |
| description: Retrieves the collection of EvTariffs resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startDateTime[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endDateTime[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: currency | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: countryCode | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxPrice | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: maxPrice[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: minPrice | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: minPrice[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[currency] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[countryCode] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[maxPrice] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[minPrice] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[startDateTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[endDateTime] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postEvTariffsCollection | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '201': | |
| description: EvTariffs resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.jsonld-ev_tariff.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| links: | |
| GetEvTariffsItem: | |
| operationId: getEvTariffsItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/ev_tariffs/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a EvTariffs resource. | |
| description: Creates a EvTariffs resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new EvTariffs resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CreateTariff.jsonld-ev_tariff.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.CreateTariff-ev_tariff.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.CreateTariff-ev_tariff.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/ev_tariffs/calculate/current: | |
| post: | |
| operationId: calculate_currentEvTariffsCollection | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '201': | |
| description: EvTariffs resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CurrentTariffCalculationResponse.jsonld-ev_tariff.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CurrentTariffCalculationResponse-ev_tariff.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CurrentTariffCalculationResponse-ev_tariff.view | |
| links: | |
| GetEvTariffsItem: | |
| operationId: getEvTariffsItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/ev_tariffs/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a EvTariffs resource. | |
| description: Creates a EvTariffs resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new EvTariffs resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CalculateCurrentTariff.jsonld-ev_tariff.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CalculateCurrentTariff-ev_tariff.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.CalculateCurrentTariff-ev_tariff.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/ev_tariffs/{id}: | |
| get: | |
| operationId: getEvTariffsItem | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '200': | |
| description: EvTariffs resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.jsonld-ev_tariff.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a EvTariffs resource. | |
| description: Retrieves a EvTariffs resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putEvTariffsItem | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '200': | |
| description: EvTariffs resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.jsonld-ev_tariff.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs-ev_tariff.view' | |
| links: | |
| GetEvTariffsItem: | |
| operationId: getEvTariffsItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/ev_tariffs/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the EvTariffs resource. | |
| description: Replaces the EvTariffs resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated EvTariffs resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvTariffs.UpdateTariff.jsonld-ev_tariff.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.UpdateTariff-ev_tariff.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvTariffs.UpdateTariff-ev_tariff.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteEvTariffsItem | |
| tags: | |
| - EvTariffs | |
| responses: | |
| '204': | |
| description: EvTariffs resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the EvTariffs resource. | |
| description: Removes the EvTariffs resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/group_assigns: | |
| get: | |
| operationId: getGroupAssignCollection | |
| tags: | |
| - GroupAssign | |
| responses: | |
| '200': | |
| description: GroupAssign collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse.jsonld-ev_group.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse-ev_group.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse-ev_group.list | |
| summary: Retrieves the collection of GroupAssign resources. | |
| description: Retrieves the collection of GroupAssign resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: group | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: group[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/group_assigns/{id}: | |
| get: | |
| operationId: getGroupAssignItem | |
| tags: | |
| - GroupAssign | |
| responses: | |
| '200': | |
| description: GroupAssign resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse.jsonld-ev_group.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse-ev_group.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/GroupAssign.GroupAssignResponse-ev_group.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a GroupAssign resource. | |
| description: Retrieves a GroupAssign resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/groups: | |
| get: | |
| operationId: getGroupCollection | |
| tags: | |
| - Group | |
| responses: | |
| '200': | |
| description: Group collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Group.GroupResponse.jsonld-ev_group.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Group.GroupResponse-ev_group.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Group.GroupResponse-ev_group.list' | |
| summary: Retrieves the collection of Group resources. | |
| description: Retrieves the collection of Group resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postGroupCollection | |
| tags: | |
| - Group | |
| responses: | |
| '201': | |
| description: Group resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Group.jsonld-ev_group.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| links: | |
| GetGroupItem: | |
| operationId: getGroupItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/groups/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Group resource. | |
| description: Creates a Group resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Group resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Group.CreateGroup.jsonld-ev_group.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group.CreateGroup-ev_group.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group.CreateGroup-ev_group.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/groups/{id}: | |
| get: | |
| operationId: getGroupItem | |
| tags: | |
| - Group | |
| responses: | |
| '200': | |
| description: Group resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Group.jsonld-ev_group.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Group resource. | |
| description: Retrieves a Group resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putGroupItem | |
| tags: | |
| - Group | |
| responses: | |
| '200': | |
| description: Group resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Group.jsonld-ev_group.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group-ev_group.view' | |
| links: | |
| GetGroupItem: | |
| operationId: getGroupItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/groups/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Group resource. | |
| description: Replaces the Group resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Group resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Group.UpdateGroup.jsonld-ev_group.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group.UpdateGroup-ev_group.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group.UpdateGroup-ev_group.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/order/payu/authorize/trusted_merchant: | |
| post: | |
| operationId: payu_authorize_trusted_merchantOrderCollection | |
| tags: | |
| - Order | |
| responses: | |
| '201': | |
| description: Order resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Order.OauthResultClientCredentials.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Order.OauthResultClientCredentials' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Order.OauthResultClientCredentials' | |
| links: | |
| GetOrderItem: | |
| operationId: getOrderItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/orders/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Order resource. | |
| description: Creates a Order resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Order resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Order.OAuthCustomerDetails.jsonld-payu.authorize.trusted | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Order.OAuthCustomerDetails-payu.authorize.trusted | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Order.OAuthCustomerDetails-payu.authorize.trusted | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/orders: | |
| get: | |
| operationId: getOrderCollection | |
| tags: | |
| - Order | |
| responses: | |
| '200': | |
| description: Order collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Order.jsonld-ev_order.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Order-ev_order.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Order-ev_order.list' | |
| summary: Retrieves the collection of Order resources. | |
| description: Retrieves the collection of Order resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: paymentProvider | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: paymentProvider[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: paymentProviderOrderId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: paymentProviderOrderId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: sessionId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: sessionId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: recreateOrderCollection | |
| tags: | |
| - Order | |
| responses: | |
| '201': | |
| description: Order resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Order.jsonld-ev_order.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Order-ev_order.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Order-ev_order.view' | |
| links: | |
| GetOrderItem: | |
| operationId: getOrderItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/orders/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Order resource. | |
| description: Creates a Order resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Order resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Order.RecreateOrder.jsonld-ev_order.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Order.RecreateOrder-ev_order.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Order.RecreateOrder-ev_order.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/orders/{id}: | |
| get: | |
| operationId: getOrderItem | |
| tags: | |
| - Order | |
| responses: | |
| '200': | |
| description: Order resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Order.jsonld-ev_order.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Order-ev_order.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Order-ev_order.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Order resource. | |
| description: Retrieves a Order resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/rfids: | |
| get: | |
| operationId: getEvRFIDCollection | |
| tags: | |
| - EvRFID | |
| responses: | |
| '200': | |
| description: EvRFID collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvRFID.jsonld-ev_rfid.view' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| summary: Retrieves the collection of EvRFID resources. | |
| description: Retrieves the collection of EvRFID resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: label | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: label[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: user | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: user[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: cardIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: cardIdentifier[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[label] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[cardIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: user.email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: user.fullName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deliveryAddress.city | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deliveryAddress.postalCode | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deliveryAddress.street | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postEvRFIDCollection | |
| tags: | |
| - EvRFID | |
| responses: | |
| '201': | |
| description: EvRFID resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.jsonld-ev_rfid.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| links: | |
| GetEvRFIDItem: | |
| operationId: getEvRFIDItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/rfids/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a EvRFID resource. | |
| description: Creates a EvRFID resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new EvRFID resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.CreateRFID.jsonld-ev_rfid.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.CreateRFID-ev_rfid.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.CreateRFID-ev_rfid.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/rfids/{id}: | |
| get: | |
| operationId: getEvRFIDItem | |
| tags: | |
| - EvRFID | |
| responses: | |
| '200': | |
| description: EvRFID resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.jsonld-ev_rfid.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a EvRFID resource. | |
| description: Retrieves a EvRFID resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putEvRFIDItem | |
| tags: | |
| - EvRFID | |
| responses: | |
| '200': | |
| description: EvRFID resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.jsonld-ev_rfid.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID-ev_rfid.view' | |
| links: | |
| GetEvRFIDItem: | |
| operationId: getEvRFIDItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/rfids/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the EvRFID resource. | |
| description: Replaces the EvRFID resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated EvRFID resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.UpdateRFID.jsonld-ev_rfid.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.UpdateRFID-ev_rfid.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvRFID.UpdateRFID-ev_rfid.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteEvRFIDItem | |
| tags: | |
| - EvRFID | |
| responses: | |
| '204': | |
| description: EvRFID resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the EvRFID resource. | |
| description: Removes the EvRFID resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_assigns: | |
| get: | |
| operationId: getTariffAssignCollection | |
| tags: | |
| - TariffAssign | |
| responses: | |
| '200': | |
| description: TariffAssign collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffAssign.jsonld-ev_tariff_assign.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| summary: Retrieves the collection of TariffAssign resources. | |
| description: Retrieves the collection of TariffAssign resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: charger.id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tariff.id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: tariff.id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: connectorIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: connectorIdentifier[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[priority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postTariffAssignCollection | |
| tags: | |
| - TariffAssign | |
| responses: | |
| '201': | |
| description: TariffAssign resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign.jsonld-ev_tariff_assign.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| links: | |
| GetTariffAssignItem: | |
| operationId: getTariffAssignItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/tariff_assigns/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a TariffAssign resource. | |
| description: Creates a TariffAssign resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new TariffAssign resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffAssign.AssignTariffToConnector.jsonld-ev_tariff_assign.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffAssign.AssignTariffToConnector-ev_tariff_assign.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffAssign.AssignTariffToConnector-ev_tariff_assign.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_assigns/{id}: | |
| get: | |
| operationId: getTariffAssignItem | |
| tags: | |
| - TariffAssign | |
| responses: | |
| '200': | |
| description: TariffAssign resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign.jsonld-ev_tariff_assign.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TariffAssign-ev_tariff_assign.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TariffAssign resource. | |
| description: Retrieves a TariffAssign resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteTariffAssignItem | |
| tags: | |
| - TariffAssign | |
| responses: | |
| '204': | |
| description: TariffAssign resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the TariffAssign resource. | |
| description: Removes the TariffAssign resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_elements: | |
| get: | |
| operationId: getTariffElementCollection | |
| tags: | |
| - TariffElement | |
| responses: | |
| '200': | |
| description: TariffElement collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffElement.jsonld-ev_tariff.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffElement-ev_tariff.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffElement-ev_tariff.list' | |
| summary: Retrieves the collection of TariffElement resources. | |
| description: Retrieves the collection of TariffElement resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_elements/{id}: | |
| get: | |
| operationId: getTariffElementItem | |
| tags: | |
| - TariffElement | |
| responses: | |
| '200': | |
| description: TariffElement resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TariffElement.jsonld-ev_tariff.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TariffElement-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TariffElement-ev_tariff.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TariffElement resource. | |
| description: Retrieves a TariffElement resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_price_components: | |
| get: | |
| operationId: getTariffPriceComponentCollection | |
| tags: | |
| - TariffPriceComponent | |
| responses: | |
| '200': | |
| description: TariffPriceComponent collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffPriceComponent.jsonld-ev_tariff.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffPriceComponent-ev_tariff.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffPriceComponent-ev_tariff.list' | |
| summary: Retrieves the collection of TariffPriceComponent resources. | |
| description: Retrieves the collection of TariffPriceComponent resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_price_components/{id}: | |
| get: | |
| operationId: getTariffPriceComponentItem | |
| tags: | |
| - TariffPriceComponent | |
| responses: | |
| '200': | |
| description: TariffPriceComponent resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffPriceComponent.jsonld-ev_tariff.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TariffPriceComponent-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TariffPriceComponent-ev_tariff.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TariffPriceComponent resource. | |
| description: Retrieves a TariffPriceComponent resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_resource_preferences: | |
| get: | |
| operationId: getTariffResourcePreferenceCollection | |
| tags: | |
| - TariffResourcePreference | |
| responses: | |
| '200': | |
| description: TariffResourcePreference collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.jsonld-ev_tariff_resource_preference.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.list | |
| summary: Retrieves the collection of TariffResourcePreference resources. | |
| description: Retrieves the collection of TariffResourcePreference resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: tariff | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: tariff[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postTariffResourcePreferenceCollection | |
| tags: | |
| - TariffResourcePreference | |
| responses: | |
| '201': | |
| description: TariffResourcePreference resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.jsonld-ev_tariff_resource_preference.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.view | |
| links: | |
| GetTariffResourcePreferenceItem: | |
| operationId: getTariffResourcePreferenceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/ev/tariff_resource_preferences/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a TariffResourcePreference resource. | |
| description: Creates a TariffResourcePreference resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new TariffResourcePreference resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.AssignPreferredTariffToResource.jsonld-ev_tariff_resource_preference.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.AssignPreferredTariffToResource-ev_tariff_resource_preference.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.AssignPreferredTariffToResource-ev_tariff_resource_preference.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_resource_preferences/{id}: | |
| get: | |
| operationId: getTariffResourcePreferenceItem | |
| tags: | |
| - TariffResourcePreference | |
| responses: | |
| '200': | |
| description: TariffResourcePreference resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference.jsonld-ev_tariff_resource_preference.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/TariffResourcePreference-ev_tariff_resource_preference.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TariffResourcePreference resource. | |
| description: Retrieves a TariffResourcePreference resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteTariffResourcePreferenceItem | |
| tags: | |
| - TariffResourcePreference | |
| responses: | |
| '204': | |
| description: TariffResourcePreference resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the TariffResourcePreference resource. | |
| description: Removes the TariffResourcePreference resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_restrictions: | |
| get: | |
| operationId: getTariffRestrictionCollection | |
| tags: | |
| - TariffRestriction | |
| responses: | |
| '200': | |
| description: TariffRestriction collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/TariffRestriction.jsonld-ev_tariff.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffRestriction-ev_tariff.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TariffRestriction-ev_tariff.list' | |
| summary: Retrieves the collection of TariffRestriction resources. | |
| description: Retrieves the collection of TariffRestriction resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tariff_restrictions/{id}: | |
| get: | |
| operationId: getTariffRestrictionItem | |
| tags: | |
| - TariffRestriction | |
| responses: | |
| '200': | |
| description: TariffRestriction resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TariffRestriction.jsonld-ev_tariff.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TariffRestriction-ev_tariff.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TariffRestriction-ev_tariff.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TariffRestriction resource. | |
| description: Retrieves a TariffRestriction resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tax_rates: | |
| get: | |
| operationId: getTaxRateCollection | |
| tags: | |
| - TaxRate | |
| responses: | |
| '200': | |
| description: TaxRate collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.list' | |
| summary: Retrieves the collection of TaxRate resources. | |
| description: Retrieves the collection of TaxRate resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: integer | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: vatRate | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: vatRate[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: currency | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: currency[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: countryCode | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: countryCode[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: organizationId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: organizationId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postTaxRateCollection | |
| tags: | |
| - TaxRate | |
| responses: | |
| '201': | |
| description: TaxRate resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| links: | |
| GetTaxRateItem: | |
| operationId: getTaxRateItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/tax_rates/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a TaxRate resource. | |
| description: Creates a TaxRate resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new TaxRate resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/tax_rates/{id}: | |
| get: | |
| operationId: getTaxRateItem | |
| tags: | |
| - TaxRate | |
| responses: | |
| '200': | |
| description: TaxRate resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a TaxRate resource. | |
| description: Retrieves a TaxRate resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putTaxRateItem | |
| tags: | |
| - TaxRate | |
| responses: | |
| '200': | |
| description: TaxRate resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.view' | |
| links: | |
| GetTaxRateItem: | |
| operationId: getTaxRateItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/tax_rates/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the TaxRate resource. | |
| description: Replaces the TaxRate resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated TaxRate resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate.jsonld-tax_rate.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/TaxRate-tax_rate.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteTaxRateItem | |
| tags: | |
| - TaxRate | |
| responses: | |
| '204': | |
| description: TaxRate resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the TaxRate resource. | |
| description: Removes the TaxRate resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users: | |
| get: | |
| operationId: getEvUsersCollection | |
| tags: | |
| - EvUsers | |
| responses: | |
| '200': | |
| description: EvUsers collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/EvUsers.UserResponse.jsonld-ev_user.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.list' | |
| summary: Retrieves the collection of EvUsers resources. | |
| description: Retrieves the collection of EvUsers resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: evIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: externalUserId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: fullName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[email] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[evIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users/ev_identifier/{id}: | |
| get: | |
| operationId: get_by_ev_identifierEvUsersItem | |
| tags: | |
| - EvUsers | |
| responses: | |
| '200': | |
| description: EvUsers resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse.jsonld-ev_user.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.view' | |
| '404': | |
| description: Resource not found | |
| summary: Return EvUser by evIdentifier | |
| description: Return EvUser by evIdentifier | |
| parameters: | |
| - name: evIdentifier | |
| in: path | |
| description: evIdentifier | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: [] | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users/verify_code: | |
| post: | |
| operationId: verify_codeEvUsersCollection | |
| tags: | |
| - EvUsers | |
| responses: | |
| '204': | |
| description: EvUsers resource created | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetEvUsersItem: | |
| operationId: getEvUsersItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/public/v1/ev/users/{id}`. | |
| '400': | |
| description: >- | |
| Problem with verify code, possible error code: | |
| INVALID_ACTIVATION_CODE, USER_IS_NOT_ENABLE, CANNOT_ACTIVATE_USER | |
| '422': | |
| description: Unprocessable entity | |
| summary: Account activation process - code verification | |
| description: Verifies whether given code is valid and activates account | |
| parameters: [] | |
| requestBody: | |
| description: The new EvUsers resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyCode.jsonld-ev_user.verification.code | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyCode-ev_user.verification.code | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyCode-ev_user.verification.code | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users/verify_user: | |
| post: | |
| operationId: verify_userEvUsersCollection | |
| tags: | |
| - EvUsers | |
| responses: | |
| '202': | |
| description: Request accepted for further handling | |
| '204': | |
| description: EvUsers resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers' | |
| links: | |
| GetEvUsersItem: | |
| operationId: getEvUsersItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/public/v1/ev/users/{id}`. | |
| '400': | |
| description: >- | |
| Problem with verify user, possible error code: USER_IS_NOT_ENABLE, | |
| CANNOT_ACTIVATE_USER, PHONE_NUMBER_ASSIGN_TO_ANOTHER_USER | |
| '422': | |
| description: Unprocessable entity | |
| summary: Account activation process - user verification | |
| description: >- | |
| Verifies whether given user may start account's activation process and | |
| sends activation code | |
| parameters: [] | |
| requestBody: | |
| description: The new EvUsers resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyUser.jsonld-ev_user.verification.user | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyUser-ev_user.verification.user | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.VerifyUser-ev_user.verification.user | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users/{id}: | |
| get: | |
| operationId: app_userEvUsersItem | |
| tags: | |
| - EvUsers | |
| responses: | |
| '200': | |
| description: EvUsers resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse.jsonld-ev_user.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.UserResponse-ev_user.view' | |
| '404': | |
| description: Resource not found | |
| summary: Return EvUser by external id | |
| description: Return EvUser by external id from system (for example Keycloak uuid) | |
| parameters: | |
| - name: id | |
| in: path | |
| description: External user id | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: [] | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/users/{id}/change_status: | |
| put: | |
| operationId: change_statusEvUsersItem | |
| tags: | |
| - EvUsers | |
| responses: | |
| '204': | |
| description: EvUsers resource updated | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetEvUsersItem: | |
| operationId: getEvUsersItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/public/v1/ev/users/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Change user status | |
| description: Change user status | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated EvUsers resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/EvUsers.ChangeStatus.jsonld-ev_user.change_status | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.ChangeStatus-ev_user.change_status' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/EvUsers.ChangeStatus-ev_user.change_status' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/ev/{id}/resources/assign: | |
| put: | |
| operationId: assignGroupGroupItem | |
| tags: | |
| - Group | |
| responses: | |
| '204': | |
| description: Group resource updated | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| links: | |
| GetGroupItem: | |
| operationId: getGroupItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/ev/groups/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Group resource. | |
| description: Replaces the Group resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Group resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Group.AssignResourcesGroup.jsonld-ev_group.assign | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Group.AssignResourcesGroup-ev_group.assign' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Group.AssignResourcesGroup-ev_group.assign' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/file/files: | |
| get: | |
| operationId: getFileCollection | |
| tags: | |
| - File | |
| responses: | |
| '200': | |
| description: File collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/File.jsonld-file.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/File-file.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/File-file.list' | |
| summary: Retrieves the collection of File resources. | |
| description: Retrieves the collection of File resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: resourceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/file/files/{id}: | |
| get: | |
| operationId: getFileItem | |
| tags: | |
| - File | |
| responses: | |
| '200': | |
| description: File resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/File.jsonld-file.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/File-file.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/File-file.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a File resource. | |
| description: Retrieves a File resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteFileItem | |
| tags: | |
| - File | |
| responses: | |
| '204': | |
| description: File resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the File resource. | |
| description: Removes the File resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/maintenance/tickets: | |
| get: | |
| operationId: getTicketCollection | |
| tags: | |
| - Ticket | |
| responses: | |
| '200': | |
| description: Ticket collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Ticket.jsonld-task.view' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Ticket-task.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Ticket-task.view' | |
| summary: Retrieves the collection of Ticket resources. | |
| description: Retrieves the collection of Ticket resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[referenceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: referenceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: referenceId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postTicketCollection | |
| tags: | |
| - Ticket | |
| responses: | |
| '201': | |
| description: Ticket resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Ticket.CreateTicketResponse.jsonld-ticket.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Ticket.CreateTicketResponse-ticket.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Ticket.CreateTicketResponse-ticket.view' | |
| links: | |
| GetTicketItem: | |
| operationId: getTicketItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/maintenance/tickets/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Ticket resource. | |
| description: Creates a Ticket resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Ticket resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Ticket.CreateTicketRequest.jsonld-ticket.write | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Ticket.CreateTicketRequest-ticket.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Ticket.CreateTicketRequest-ticket.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/maintenance/tickets/{id}: | |
| get: | |
| operationId: getTicketItem | |
| tags: | |
| - Ticket | |
| responses: | |
| '200': | |
| description: Ticket resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Ticket.jsonld-task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Ticket-task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Ticket-task.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Ticket resource. | |
| description: Retrieves a Ticket resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarm/{id}/aggregation: | |
| get: | |
| operationId: aggregationAlarmItem | |
| tags: | |
| - Alarm | |
| responses: | |
| '200': | |
| description: Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.AlarmAggregationResponse.jsonld-alarm_occurrence.view | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.AlarmAggregationResponse-alarm_occurrence.view | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.AlarmAggregationResponse-alarm_occurrence.view | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Alarm resource. | |
| description: Retrieves a Alarm resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarm_occurrences: | |
| get: | |
| operationId: getAlarmOccurrenceCollection | |
| tags: | |
| - AlarmOccurrence | |
| responses: | |
| '200': | |
| description: AlarmOccurrence collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AlarmOccurrence.jsonld-alarm_occurrence.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AlarmOccurrence-alarm_occurrence.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/AlarmOccurrence-alarm_occurrence.list' | |
| summary: Retrieves the collection of AlarmOccurrence resources. | |
| description: Retrieves the collection of AlarmOccurrence resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[occurredAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[seen] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: alarm | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: alarm[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: occurredAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[between] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[gt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[gte] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[lt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[lte] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarm_occurrences/{id}: | |
| get: | |
| operationId: getAlarmOccurrenceItem | |
| tags: | |
| - AlarmOccurrence | |
| responses: | |
| '200': | |
| description: AlarmOccurrence resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/AlarmOccurrence.jsonld-alarm_occurrence.view | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence-alarm_occurrence.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence-alarm_occurrence.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a AlarmOccurrence resource. | |
| description: Retrieves a AlarmOccurrence resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarm_occurrences/{id}/seen: | |
| post: | |
| operationId: mark_as_seenAlarmOccurrenceItem | |
| tags: | |
| - AlarmOccurrence | |
| responses: | |
| '201': | |
| description: AlarmOccurrence resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence' | |
| links: | |
| GetAlarmOccurrenceItem: | |
| operationId: getAlarmOccurrenceItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/alarm_occurrences/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a AlarmOccurrence resource. | |
| description: Creates a AlarmOccurrence resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new AlarmOccurrence resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/AlarmOccurrence' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarm_occurrences/{siteId}/unseen: | |
| get: | |
| operationId: unseenAlarmOccurrenceCollection | |
| tags: | |
| - AlarmOccurrence | |
| responses: | |
| '200': | |
| description: AlarmOccurrence collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AlarmOccurrence.UnseenAlarmOccurrencesResponse.jsonld-alarm_occurrence.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AlarmOccurrence.UnseenAlarmOccurrencesResponse-alarm_occurrence.list | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/AlarmOccurrence.UnseenAlarmOccurrencesResponse-alarm_occurrence.list | |
| summary: Retrieves the collection of AlarmOccurrence resources. | |
| description: Retrieves the collection of AlarmOccurrence resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[occurredAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[seen] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: alarm | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: alarm[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: occurredAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[between] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[gt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[gte] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[lt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: occurredAt[lte] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarms: | |
| get: | |
| operationId: getAlarmCollection | |
| tags: | |
| - Alarm | |
| responses: | |
| '200': | |
| description: Alarm collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Alarm.jsonld-alarm.list_postpone.resource.read | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Alarm-alarm.list_postpone.resource.read' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Alarm-alarm.list_postpone.resource.read' | |
| summary: Retrieves the collection of Alarm resources. | |
| description: Retrieves the collection of Alarm resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[priority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[state] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: assignee | |
| in: query | |
| description: Filter App\Maintenance\Entity\Alarm by assignee | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: description | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: state | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: dueDate[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAlarmCollection | |
| tags: | |
| - Alarm | |
| responses: | |
| '201': | |
| description: Alarm resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.jsonld-alarm.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view' | |
| links: | |
| GetAlarmItem: | |
| operationId: getAlarmItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/alarms/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Alarm resource. | |
| description: Creates a Alarm resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.jsonld-alarm.create' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.create' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.create' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarms/postpone: | |
| post: | |
| operationId: postponeAlarmCollection | |
| tags: | |
| - Alarm | |
| responses: | |
| '201': | |
| description: Alarm resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.jsonld-postpone.resource.read' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-postpone.resource.read' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-postpone.resource.read' | |
| links: | |
| GetAlarmItem: | |
| operationId: getAlarmItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/alarms/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Alarm resource. | |
| description: Creates a Alarm resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.PostponeRequest.jsonld-postpone.resource.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.PostponeRequest-postpone.resource.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.PostponeRequest-postpone.resource.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarms/priority/increment: | |
| post: | |
| operationId: incrementAlarmCollection | |
| tags: | |
| - Alarm | |
| responses: | |
| '201': | |
| description: Alarm resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.AlarmPriorityIncrementResponseDTO.jsonld | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.AlarmPriorityIncrementResponseDTO' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.AlarmPriorityIncrementResponseDTO' | |
| links: | |
| GetAlarmItem: | |
| operationId: getAlarmItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/alarms/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Alarm resource. | |
| description: Creates a Alarm resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/alarms/{id}: | |
| get: | |
| operationId: getAlarmItem | |
| tags: | |
| - Alarm | |
| responses: | |
| '200': | |
| description: Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Alarm.jsonld-alarm.view_postpone.resource.read | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view_postpone.resource.read' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view_postpone.resource.read' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Alarm resource. | |
| description: Retrieves a Alarm resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putAlarmItem | |
| tags: | |
| - Alarm | |
| responses: | |
| '200': | |
| description: Alarm resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.jsonld-alarm.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.view' | |
| links: | |
| GetAlarmItem: | |
| operationId: getAlarmItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/alarms/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Alarm resource. | |
| description: Replaces the Alarm resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Alarm resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm.jsonld-alarm.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Alarm-alarm.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteAlarmItem | |
| tags: | |
| - Alarm | |
| responses: | |
| '204': | |
| description: Alarm resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Alarm resource. | |
| description: Removes the Alarm resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/periodic_tasks: | |
| get: | |
| operationId: getPeriodicTaskCollection | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '200': | |
| description: PeriodicTask collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/PeriodicTask.jsonld-periodic_task.list | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.list' | |
| summary: Retrieves the collection of PeriodicTask resources. | |
| description: Retrieves the collection of PeriodicTask resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[status] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: status[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: description | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postPeriodicTaskCollection | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '201': | |
| description: PeriodicTask resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld-periodic_task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| links: | |
| GetPeriodicTaskItem: | |
| operationId: getPeriodicTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/periodic_tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a PeriodicTask resource. | |
| description: Creates a PeriodicTask resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new PeriodicTask resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld-periodic_task.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/periodic_tasks/{id}: | |
| get: | |
| operationId: getPeriodicTaskItem | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '200': | |
| description: PeriodicTask resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld-periodic_task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a PeriodicTask resource. | |
| description: Retrieves a PeriodicTask resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putPeriodicTaskItem | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '200': | |
| description: PeriodicTask resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld-periodic_task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.view' | |
| links: | |
| GetPeriodicTaskItem: | |
| operationId: getPeriodicTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/periodic_tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the PeriodicTask resource. | |
| description: Replaces the PeriodicTask resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated PeriodicTask resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld-periodic_task.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask-periodic_task.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deletePeriodicTaskItem | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '204': | |
| description: PeriodicTask resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the PeriodicTask resource. | |
| description: Removes the PeriodicTask resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/periodic_tasks/{id}/toggle: | |
| post: | |
| operationId: togglePeriodicTaskItem | |
| tags: | |
| - PeriodicTask | |
| responses: | |
| '201': | |
| description: PeriodicTask resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/PeriodicTask' | |
| links: | |
| GetPeriodicTaskItem: | |
| operationId: getPeriodicTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/monitoring/periodic_tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a PeriodicTask resource. | |
| description: Creates a PeriodicTask resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The new PeriodicTask resource | |
| content: | |
| application/ld+json: | |
| schema: {} | |
| application/json: | |
| schema: {} | |
| text/html: | |
| schema: {} | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/statistics: | |
| get: | |
| operationId: monitoring_statisticsAlarmCollection | |
| tags: | |
| - Alarm | |
| responses: | |
| '200': | |
| description: Alarm and task statistics | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| openedAlarmsTotal: | |
| type: integer | |
| description: All opened alarms | |
| criticalAlarmsTotal: | |
| type: integer | |
| description: All opened and critical alarms | |
| tasksOpenedTotal: | |
| type: integer | |
| description: All opened tasks total | |
| example: | |
| openedAlarmsTotal: 10 | |
| criticalAlarmsTotal: 5 | |
| tasksOpenedTotal: 25 | |
| summary: Get alarm and task statistics | |
| description: Get alarm and task statistics | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[priority] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[state] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.deviceIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[site.name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: assignee | |
| in: query | |
| description: Filter App\Maintenance\Entity\Alarm by assignee | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: device.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: device.asset.type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: site | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: site[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: site.name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: description | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: state | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: severity[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: dueDate[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: dueDate[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/tasks: | |
| get: | |
| operationId: getTaskCollection | |
| tags: | |
| - Task | |
| responses: | |
| '200': | |
| description: Task collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Task.jsonld-task.list_postpone.resource.read | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Task-task.list_postpone.resource.read' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Task-task.list_postpone.resource.read' | |
| summary: Retrieves the collection of Task resources. | |
| description: Retrieves the collection of Task resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[device.externalDeviceId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdBy] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedBy] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[state] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[assignee] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[title] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[dueDate] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[site.name] | |
| in: query | |
| description: Order tasks by site name | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdBy | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdBy[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: updatedBy | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedBy[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: state | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: state[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: sites | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: sites[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: devices | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: devices[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: alarm | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: alarm[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: assignee | |
| in: query | |
| description: Filter App\Maintenance\Entity\Task by assignee | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: title | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postTaskCollection | |
| tags: | |
| - Task | |
| responses: | |
| '201': | |
| description: Task resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Task.jsonld-task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view' | |
| links: | |
| GetTaskItem: | |
| operationId: getTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/monitoring/tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Task resource. | |
| description: Creates a Task resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Task resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Task.jsonld-task.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/tasks/postpone: | |
| post: | |
| operationId: postponeTaskCollection | |
| tags: | |
| - Task | |
| responses: | |
| '201': | |
| description: Task resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Task.jsonld-postpone.resource.read' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-postpone.resource.read' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-postpone.resource.read' | |
| links: | |
| GetTaskItem: | |
| operationId: getTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/monitoring/tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Task resource. | |
| description: Creates a Task resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Task resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Task.PostponeRequest.jsonld-postpone.resource.write | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Task.PostponeRequest-postpone.resource.write | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Task.PostponeRequest-postpone.resource.write | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/monitoring/tasks/{id}: | |
| get: | |
| operationId: getTaskItem | |
| tags: | |
| - Task | |
| responses: | |
| '200': | |
| description: Task resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/Task.jsonld-task.view_postpone.resource.read | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view_postpone.resource.read' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view_postpone.resource.read' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Task resource. | |
| description: Retrieves a Task resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putTaskItem | |
| tags: | |
| - Task | |
| responses: | |
| '200': | |
| description: Task resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Task.jsonld-task.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.view' | |
| links: | |
| GetTaskItem: | |
| operationId: getTaskItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/monitoring/tasks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Task resource. | |
| description: Replaces the Task resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Task resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Task.jsonld-task.update_task.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.update_task.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Task-task.update_task.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteTaskItem | |
| tags: | |
| - Task | |
| responses: | |
| '204': | |
| description: Task resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Task resource. | |
| description: Removes the Task resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/organization/organization_logo_marks: | |
| get: | |
| operationId: getOrganizationLogoMarkCollection | |
| tags: | |
| - OrganizationLogoMark | |
| responses: | |
| '200': | |
| description: OrganizationLogoMark collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark.jsonld-organization_logo_mark.upload | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization_logo_mark.upload | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization_logo_mark.upload | |
| summary: Retrieves the collection of OrganizationLogoMark resources. | |
| description: Retrieves the collection of OrganizationLogoMark resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postOrganizationLogoMarkCollection | |
| tags: | |
| - OrganizationLogoMark | |
| responses: | |
| '201': | |
| description: OrganizationLogoMark resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark.jsonld-organization.image.upload | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization.image.upload | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization.image.upload | |
| links: | |
| GetOrganizationLogoMarkItem: | |
| operationId: getOrganizationLogoMarkItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/organization/organization_logo_marks/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a OrganizationLogoMark resource. | |
| description: Creates a OrganizationLogoMark resource. | |
| parameters: [] | |
| requestBody: | |
| description: '' | |
| content: | |
| multipart/form-data: | |
| schema: | |
| type: object | |
| properties: | |
| file: | |
| type: string | |
| format: binary | |
| site: | |
| type: string | |
| format: json | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/organization/organization_logo_marks/{id}: | |
| get: | |
| operationId: getOrganizationLogoMarkItem | |
| tags: | |
| - OrganizationLogoMark | |
| responses: | |
| '200': | |
| description: OrganizationLogoMark resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark.jsonld-organization_logo_mark.upload | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization_logo_mark.upload | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogoMark-organization_logo_mark.upload | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a OrganizationLogoMark resource. | |
| description: Retrieves a OrganizationLogoMark resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteOrganizationLogoMarkItem | |
| tags: | |
| - OrganizationLogoMark | |
| responses: | |
| '204': | |
| description: OrganizationLogoMark resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the OrganizationLogoMark resource. | |
| description: Removes the OrganizationLogoMark resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/organization/organization_logos: | |
| get: | |
| operationId: getOrganizationLogoCollection | |
| tags: | |
| - OrganizationLogo | |
| responses: | |
| '200': | |
| description: OrganizationLogo collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo.jsonld-organization_logo.upload | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo-organization_logo.upload | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo-organization_logo.upload | |
| summary: Retrieves the collection of OrganizationLogo resources. | |
| description: Retrieves the collection of OrganizationLogo resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postOrganizationLogoCollection | |
| tags: | |
| - OrganizationLogo | |
| responses: | |
| '201': | |
| description: OrganizationLogo resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo.jsonld-organization.image.upload | |
| application/json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo-organization.image.upload | |
| text/html: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo-organization.image.upload | |
| links: | |
| GetOrganizationLogoItem: | |
| operationId: getOrganizationLogoItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET | |
| /api/core/protected/v1/organization/organization_logos/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a OrganizationLogo resource. | |
| description: Creates a OrganizationLogo resource. | |
| parameters: [] | |
| requestBody: | |
| description: '' | |
| content: | |
| multipart/form-data: | |
| schema: | |
| type: object | |
| properties: | |
| file: | |
| type: string | |
| format: binary | |
| site: | |
| type: string | |
| format: json | |
| required: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/organization/organization_logos/{id}: | |
| get: | |
| operationId: getOrganizationLogoItem | |
| tags: | |
| - OrganizationLogo | |
| responses: | |
| '200': | |
| description: OrganizationLogo resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: >- | |
| #/components/schemas/OrganizationLogo.jsonld-organization_logo.upload | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/OrganizationLogo-organization_logo.upload' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/OrganizationLogo-organization_logo.upload' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a OrganizationLogo resource. | |
| description: Retrieves a OrganizationLogo resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteOrganizationLogoItem | |
| tags: | |
| - OrganizationLogo | |
| responses: | |
| '204': | |
| description: OrganizationLogo resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the OrganizationLogo resource. | |
| description: Removes the OrganizationLogo resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/reports: | |
| get: | |
| operationId: getReportCollection | |
| tags: | |
| - Report | |
| responses: | |
| '200': | |
| description: Report collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Report.jsonld-report.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Report-report.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Report-report.list' | |
| summary: Retrieves the collection of Report resources. | |
| description: Retrieves the collection of Report resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: devices.asset.id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: devices.asset.id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: reportType | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: reportType[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: order[startAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[endAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[reportType] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: devices.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: devices.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: startAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: endAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postReportCollection | |
| tags: | |
| - Report | |
| responses: | |
| '202': | |
| description: Report resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Report.jsonld-report.write.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Report-report.write.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Report-report.write.view' | |
| links: | |
| GetReportItem: | |
| operationId: getReportItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/reports/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Report resource. | |
| description: Creates a Report resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Report resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Report.CreateReport.jsonld-report.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Report.CreateReport-report.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Report.CreateReport-report.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/reports/{id}: | |
| get: | |
| operationId: getReportItem | |
| tags: | |
| - Report | |
| responses: | |
| '200': | |
| description: Report resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Report.jsonld-report.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Report-report.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Report-report.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Report resource. | |
| description: Retrieves a Report resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| delete: | |
| operationId: deleteReportItem | |
| tags: | |
| - Report | |
| responses: | |
| '204': | |
| description: Report resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Report resource. | |
| description: Removes the Report resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/addresses: | |
| get: | |
| operationId: getAddressCollection | |
| tags: | |
| - Address | |
| responses: | |
| '200': | |
| description: Address collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Address.jsonld-address.list_address.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| summary: Retrieves the collection of Address resources. | |
| description: Retrieves the collection of Address resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[street] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[city] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[zipCode] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[country] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[latitude] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[longitude] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[timezone] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: street | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: city | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: zipCode | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: country | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: latitude | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: latitude[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: longitude | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: number | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: longitude[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: number | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: timezone | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postAddressCollection | |
| tags: | |
| - Address | |
| responses: | |
| '201': | |
| description: Address resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.list_address.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| links: | |
| GetAddressItem: | |
| operationId: getAddressItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/site/addresses/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Address resource. | |
| description: Creates a Address resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Address resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/addresses/{id}: | |
| get: | |
| operationId: getAddressItem | |
| tags: | |
| - Address | |
| responses: | |
| '200': | |
| description: Address resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.list_address.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Address resource. | |
| description: Retrieves a Address resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putAddressItem | |
| tags: | |
| - Address | |
| responses: | |
| '200': | |
| description: Address resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.list_address.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| links: | |
| GetAddressItem: | |
| operationId: getAddressItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/site/addresses/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Address resource. | |
| description: Replaces the Address resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Address resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteAddressItem | |
| tags: | |
| - Address | |
| responses: | |
| '204': | |
| description: Address resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Address resource. | |
| description: Removes the Address resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| patch: | |
| operationId: patchAddressItem | |
| tags: | |
| - Address | |
| responses: | |
| '200': | |
| description: Address resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Address.jsonld-address.list_address.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.list_address.view' | |
| links: | |
| GetAddressItem: | |
| operationId: getAddressItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/site/addresses/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Updates the Address resource. | |
| description: Updates the Address resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Address resource | |
| content: | |
| application/merge-patch+json: | |
| schema: | |
| $ref: '#/components/schemas/Address-address.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/client_addresses: | |
| get: | |
| operationId: getClientAddressCollection | |
| tags: | |
| - ClientAddress | |
| responses: | |
| '200': | |
| description: ClientAddress collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress' | |
| summary: Retrieves the collection of ClientAddress resources. | |
| description: Retrieves the collection of ClientAddress resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postClientAddressCollection | |
| tags: | |
| - ClientAddress | |
| responses: | |
| '201': | |
| description: ClientAddress resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| links: | |
| GetClientAddressItem: | |
| operationId: getClientAddressItem | |
| parameters: | |
| client: $response.body#/client | |
| address: $response.body#/address | |
| type: $response.body#/type | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/site/client_addresses/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a ClientAddress resource. | |
| description: Creates a ClientAddress resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new ClientAddress resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress.jsonld-client_address.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress-client_address.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress-client_address.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/client_addresses/{id}: | |
| get: | |
| operationId: getClientAddressItem | |
| tags: | |
| - ClientAddress | |
| responses: | |
| '200': | |
| description: ClientAddress resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ClientAddress resource. | |
| description: Retrieves a ClientAddress resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putClientAddressItem | |
| tags: | |
| - ClientAddress | |
| responses: | |
| '200': | |
| description: ClientAddress resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress' | |
| links: | |
| GetClientAddressItem: | |
| operationId: getClientAddressItem | |
| parameters: | |
| client: $response.body#/client | |
| address: $response.body#/address | |
| type: $response.body#/type | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/site/client_addresses/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ClientAddress resource. | |
| description: Replaces the ClientAddress resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ClientAddress resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress.jsonld-client_address.update' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress-client_address.update' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientAddress-client_address.update' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteClientAddressItem | |
| tags: | |
| - ClientAddress | |
| responses: | |
| '204': | |
| description: ClientAddress resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the ClientAddress resource. | |
| description: Removes the ClientAddress resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/client_contacts: | |
| get: | |
| operationId: getClientContactCollection | |
| tags: | |
| - ClientContact | |
| responses: | |
| '200': | |
| description: ClientContact collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientContact' | |
| summary: Retrieves the collection of ClientContact resources. | |
| description: Retrieves the collection of ClientContact resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: client | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: client[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: type | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: type[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: contact.firstName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.lastName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.email | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.phoneNumber | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: contact.jobTitle | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postClientContactCollection | |
| tags: | |
| - ClientContact | |
| responses: | |
| '201': | |
| description: ClientContact resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| links: | |
| GetClientContactItem: | |
| operationId: getClientContactItem | |
| parameters: | |
| client: $response.body#/client | |
| contact: $response.body#/contact | |
| type: $response.body#/type | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/site/client_contacts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a ClientContact resource. | |
| description: Creates a ClientContact resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new ClientContact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/client_contacts/{id}: | |
| get: | |
| operationId: getClientContactItem | |
| tags: | |
| - ClientContact | |
| responses: | |
| '200': | |
| description: ClientContact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a ClientContact resource. | |
| description: Retrieves a ClientContact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putClientContactItem | |
| tags: | |
| - ClientContact | |
| responses: | |
| '200': | |
| description: ClientContact resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| links: | |
| GetClientContactItem: | |
| operationId: getClientContactItem | |
| parameters: | |
| client: $response.body#/client | |
| contact: $response.body#/contact | |
| type: $response.body#/type | |
| description: >- | |
| The values returned in the response can be used in `GET | |
| /api/core/protected/v1/site/client_contacts/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the ClientContact resource. | |
| description: Replaces the ClientContact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated ClientContact resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact.jsonld' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/ClientContact' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteClientContactItem | |
| tags: | |
| - ClientContact | |
| responses: | |
| '204': | |
| description: ClientContact resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the ClientContact resource. | |
| description: Removes the ClientContact resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients: | |
| get: | |
| operationId: getClientCollection | |
| tags: | |
| - Client | |
| responses: | |
| '200': | |
| description: Client collection | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Client.jsonld-client.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Client-client.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Client-client.list' | |
| summary: Retrieves the collection of Client resources. | |
| description: Retrieves the collection of Client resources. | |
| parameters: | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[operationalTimezone] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[currency] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[description] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[performanceReports] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: code[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: operationalTimezone | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: currency | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: currency[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: systemOperator | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: systemOperator[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: description | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: performanceReports | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: performanceReports[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: boolean | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| post: | |
| operationId: postClientCollection | |
| tags: | |
| - Client | |
| responses: | |
| '201': | |
| description: Client resource created | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Client.jsonld-client.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| links: | |
| GetClientItem: | |
| operationId: getClientItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/site/clients/{id}`. | |
| '400': | |
| description: Invalid input | |
| '422': | |
| description: Unprocessable entity | |
| summary: Creates a Client resource. | |
| description: Creates a Client resource. | |
| parameters: [] | |
| requestBody: | |
| description: The new Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Client.jsonld-client.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.write' | |
| required: true | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients/{id}: | |
| get: | |
| operationId: getClientItem | |
| tags: | |
| - Client | |
| responses: | |
| '200': | |
| description: Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Client.jsonld-client.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| '404': | |
| description: Resource not found | |
| summary: Retrieves a Client resource. | |
| description: Retrieves a Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| put: | |
| operationId: putClientItem | |
| tags: | |
| - Client | |
| responses: | |
| '200': | |
| description: Client resource updated | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Client.jsonld-client.view' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.view' | |
| links: | |
| GetClientItem: | |
| operationId: getClientItem | |
| parameters: | |
| id: $response.body#/id | |
| description: >- | |
| The `id` value returned in the response can be used as the `id` | |
| parameter in `GET /api/core/protected/v1/site/clients/{id}`. | |
| '400': | |
| description: Invalid input | |
| '404': | |
| description: Resource not found | |
| '422': | |
| description: Unprocessable entity | |
| summary: Replaces the Client resource. | |
| description: Replaces the Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| requestBody: | |
| description: The updated Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| $ref: '#/components/schemas/Client.jsonld-client.write' | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.write' | |
| text/html: | |
| schema: | |
| $ref: '#/components/schemas/Client-client.write' | |
| required: true | |
| deprecated: false | |
| delete: | |
| operationId: deleteClientItem | |
| tags: | |
| - Client | |
| responses: | |
| '204': | |
| description: Client resource deleted | |
| '404': | |
| description: Resource not found | |
| summary: Removes the Client resource. | |
| description: Removes the Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Resource identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients/{id}/client_addresses: | |
| get: | |
| operationId: api_clients_client_addresses_get_subresourceClientSubresource | |
| tags: | |
| - ClientAddress | |
| - Client | |
| responses: | |
| '200': | |
| description: Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/ClientAddress' | |
| summary: Retrieves a Client resource. | |
| description: Retrieves a Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Client identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients/{id}/sites: | |
| get: | |
| operationId: api_clients_sites_get_subresourceClientSubresource | |
| tags: | |
| - Site | |
| - Client | |
| responses: | |
| '200': | |
| description: Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Site.jsonld-site.view_site.list' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Site-site.view_site.list' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/Site-site.view_site.list' | |
| summary: Retrieves a Client resource. | |
| description: Retrieves a Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Client identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[code] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[name] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[stage] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_before] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[strictly_after] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: code | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: name | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: stage | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: stage[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: organizationId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: organizationId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: client | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: client[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: owners.ownerId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: owners.ownerId[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: servicePoints.devices.deviceIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: servicePoints.devices.externalDeviceId | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: address.street | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: address.city | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: address.country | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: id | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: id[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: code[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: name[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: displayName | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: displayName[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: edgeControllerIdentifier | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: edgeControllerIdentifier[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: createdAt | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdAt[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedAt[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdBy | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: createdBy[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: updatedBy | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: updatedBy[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| style: form | |
| explode: true | |
| allowReserved: false | |
| - name: deletedAt | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: deletedAt[] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[id] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[displayName] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[edgeControllerIdentifier] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[createdBy] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[updatedBy] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[organizationId] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[deletedAt] | |
| in: query | |
| description: '' | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| enum: | |
| - asc | |
| - desc | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: withDevicesOnly | |
| in: query | |
| description: Return sites with at least one registered device | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: withRegisteredPowerMeter | |
| in: query | |
| description: Return sites with at least one registered power meter | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients/{id}/sites/{sites}/images: | |
| get: | |
| operationId: api_clients_sites_images_get_subresourceClientSubresource | |
| tags: | |
| - SiteImage | |
| - Site | |
| responses: | |
| '200': | |
| description: Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SiteImage.jsonld' | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SiteImage' | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/SiteImage' | |
| summary: Retrieves a Client resource. | |
| description: Retrieves a Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Client identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: sites | |
| in: path | |
| description: Site identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| deprecated: false | |
| parameters: [] | |
| /api/core/protected/v1/site/clients/{id}/sites/{sites}/maintainers: | |
| get: | |
| operationId: api_clients_sites_maintainers_get_subresourceClientSubresource | |
| tags: | |
| - Maintainer | |
| - Site | |
| responses: | |
| '200': | |
| description: Client resource | |
| content: | |
| application/ld+json: | |
| schema: | |
| type: object | |
| properties: | |
| hydra:member: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Maintainer.MaintainerDetailResponse.jsonld-maintainer.view | |
| hydra:totalItems: | |
| type: integer | |
| minimum: 0 | |
| hydra:view: | |
| type: object | |
| properties: | |
| '@id': | |
| type: string | |
| format: iri-reference | |
| '@type': | |
| type: string | |
| hydra:first: | |
| type: string | |
| format: iri-reference | |
| hydra:last: | |
| type: string | |
| format: iri-reference | |
| hydra:previous: | |
| type: string | |
| format: iri-reference | |
| hydra:next: | |
| type: string | |
| format: iri-reference | |
| hydra:search: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| hydra:template: | |
| type: string | |
| hydra:variableRepresentation: | |
| type: string | |
| hydra:mapping: | |
| type: array | |
| items: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| variable: | |
| type: string | |
| property: | |
| type: string | |
| nullable: true | |
| required: | |
| type: boolean | |
| required: | |
| - hydra:member | |
| application/json: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Maintainer.MaintainerDetailResponse-maintainer.view | |
| text/html: | |
| schema: | |
| type: array | |
| items: | |
| $ref: >- | |
| #/components/schemas/Maintainer.MaintainerDetailResponse-maintainer.view | |
| summary: Retrieves a Client resource. | |
| description: Retrieves a Client resource. | |
| parameters: | |
| - name: id | |
| in: path | |
| description: Client identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: sites | |
| in: path | |
| description: Site identifier | |
| required: true | |
| deprecated: false | |
| allowEmptyValue: false | |
| schema: | |
| type: string | |
| style: simple | |
| explode: false | |
| allowReserved: false | |
| - name: page | |
| in: query | |
| description: The collection page number | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 1 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: itemsPerPage | |
| in: query | |
| description: The number of items per page | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: integer | |
| default: 30 | |
| minimum: 0 | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: pagination | |
| in: query | |
| description: Enable or disable pagination | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: boolean | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[firstName] | |
| in: query | |
| description: Order by given field name. | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[lastName] | |
| in: query | |
| description: Order by given field name. | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[email] | |
| in: query | |
| description: Order by given field name. | |
| required: false | |
| deprecated: false | |
| allowEmptyValue: true | |
| schema: | |
| type: string | |
| style: form | |
| explode: false | |
| allowReserved: false | |
| - name: order[phoneNumber] | |
| in: query | |
| de |
View raw
(Sorry about that, but we can’t show files that are this big right now.)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment