publiq Productions API

openapi: 3.2.0
info:
  title: Entry Productions API
  version: '3.0'
  description: With UiTdatabank's Entry API you can create new events, places and organizers, and add extra info to them with specific requests to add/update properties. For example there are operations to add a label, remove a label, add an image, and so on.
  contact:
    name: publiq helpdesk
    email: technical-support@publiq.be
    url: https://docs.publiq.be
  x-source: https://raw.githubusercontent.com/cultuurnet/apidocs/main/../../../private/tmp/publiq-src/apidocs-main/projects/uitdatabank/reference/entry.json
servers:
- url: https://io-test.uitdatabank.be
  description: Testing
- url: https://io.uitdatabank.be
  description: Production
tags:
- name: Productions
paths:
  /productions/{productionId1}/merge/{productionId2}:
    parameters:
    - $ref: '#/components/parameters/productionId1'
    - $ref: '#/components/parameters/productionId2'
    post:
      summary: productions - merge
      operationId: productions-merge
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Productions
      security:
      - USER_ACCESS_TOKEN: []
      - CLIENT_ACCESS_TOKEN: []
      x-internal: true
      description: Merges to productions into one. If the request is successful a `204 No Content` will be returned.
  /productions/{productionId}/events/{eventId}:
    parameters:
    - $ref: '#/components/parameters/productionId'
    - $ref: '#/components/parameters/eventId'
    put:
      summary: productions - add event
      operationId: productions-add-event
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Productions
      security:
      - USER_ACCESS_TOKEN: []
      - CLIENT_ACCESS_TOKEN: []
      x-internal: true
      description: Add a single event to an existing production. If the request is successful a `204 No Content` will be returned.
  /productions/skip:
    post:
      summary: productions - skip
      operationId: productions-skip
      responses:
        '200':
          description: The production was skipped successfully
          content:
            application/ld+json:
              schema:
                title: production.skip
                x-stoplight:
                  id: f00f510de9fe7
                type: object
                x-internal: true
                examples:
                - eventIds:
                  - e1881d57-569a-49f9-a238-cfdafae8d46b
                  - f8c8e192-be53-4c54-a59d-28e5525a29f5
                properties:
                  eventIds:
                    title: production.eventIds
                    type: string
                    format: uuid
                    description: The event id's that are part of the production
                    examples:
                    - 46e9ea9f-fc42-4759-a81b-4308467b7c35
                required:
                - eventIds
        '400':
          description: 'Bad Request. Possible error types:


            * https://api.publiq.be/probs/body/missing

            * https://api.publiq.be/probs/body/invalid-syntax

            * https://api.publiq.be/probs/body/invalid-data'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid data:
                  value:
                    type: https://api.publiq.be/probs/body/invalid-data
                    title: Invalid body data
                    status: 400
                    schemaErrors:
                    - jsonPointer: /
                      error: The required property (eventIds) is missing.
      tags:
      - Productions
      description: Skip a pair of suggested events. The suggested pair will not be linked to a production and will not be suggested again.
      security:
      - USER_ACCESS_TOKEN: []
      - CLIENT_ACCESS_TOKEN: []
      x-internal: true
      requestBody:
        description: The complete details of the new production to create.
        content:
          application/json:
            schema:
              title: production.skip
              x-stoplight:
                id: f00f510de9fe7
              type: object
              x-internal: true
              examples:
              - eventIds:
                - e1881d57-569a-49f9-a238-cfdafae8d46b
                - f8c8e192-be53-4c54-a59d-28e5525a29f5
              properties:
                eventIds:
                  title: production.eventIds
                  type: string
                  format: uuid
                  description: The event id's that are part of the production
                  examples:
                  - 46e9ea9f-fc42-4759-a81b-4308467b7c35
              required:
              - eventIds
  /productions:
    post:
      summary: productions - create
      operationId: productions-create
      responses:
        '201':
          description: The production was created successfully
          content:
            application/ld+json:
              schema:
                title: production.post
                type: object
                x-internal: true
                examples:
                - name: Don Vitalski - Gewoon Blijven Ademen
                  eventIds:
                  - 17c84549-15c5-4dd4-974f-3becdcd952c8
                  - 7ee2e70d-78ee-4436-bbcf-1b2ecdd945af
                - name: Kommil Foo - GRIND
                  eventIds:
                  - 04923b0e-aefc-480b-a1b6-8e5f7ed1d3d6
                  - 04e2e6f8-dda1-4531-b4f8-736eecc46f18
                  - 0618c6a0-ab16-4c7d-a291-89b495120a39
                  - 07fb8c75-5f34-44bc-9e67-ffe20de6cf2b
                  - 08d88c9a-2523-4b8f-b774-6f39ed4dcf0e
                  - 0dfc2b41-74a6-4cff-ae9b-51300ac611e6
                  - 0fd38824-3dac-4b9d-ae15-f5a3951dc282
                  - 1492676c-0bce-4245-844e-9bf1643d1a2f
                properties:
                  name:
                    type: string
                    description: The name of the production. The name includes the performer and the title of the played piece or event.
                    example: Kommil Foo - GRIND
                  eventIds:
                    title: production.eventIds
                    type: string
                    format: uuid
                    description: The event id's that are part of the production
                    examples:
                    - 46e9ea9f-fc42-4759-a81b-4308467b7c35
                required:
                - name
                - eventIds
            application/json:
              schema:
                title: production.post
                type: object
                x-internal: true
                examples:
                - name: Don Vitalski - Gewoon Blijven Ademen
                  eventIds:
                  - 17c84549-15c5-4dd4-974f-3becdcd952c8
                  - 7ee2e70d-78ee-4436-bbcf-1b2ecdd945af
                - name: Kommil Foo - GRIND
                  eventIds:
                  - 04923b0e-aefc-480b-a1b6-8e5f7ed1d3d6
                  - 04e2e6f8-dda1-4531-b4f8-736eecc46f18
                  - 0618c6a0-ab16-4c7d-a291-89b495120a39
                  - 07fb8c75-5f34-44bc-9e67-ffe20de6cf2b
                  - 08d88c9a-2523-4b8f-b774-6f39ed4dcf0e
                  - 0dfc2b41-74a6-4cff-ae9b-51300ac611e6
                  - 0fd38824-3dac-4b9d-ae15-f5a3951dc282
                  - 1492676c-0bce-4245-844e-9bf1643d1a2f
                properties:
                  name:
                    type: string
                    description: The name of the production. The name includes the performer and the title of the played piece or event.
                    example: Kommil Foo - GRIND
                  eventIds:
                    title: production.eventIds
                    type: string
                    format: uuid
                    description: The event id's that are part of the production
                    examples:
                    - 46e9ea9f-fc42-4759-a81b-4308467b7c35
                required:
                - name
                - eventIds
        '400':
          description: 'Bad Request. Possible error types:


            * https://api.publiq.be/probs/body/missing

            * https://api.publiq.be/probs/body/invalid-syntax

            * https://api.publiq.be/probs/body/invalid-data'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid data:
                  value:
                    type: https://api.publiq.be/probs/body/invalid-data
                    title: Invalid body data
                    status: 400
                    schemaErrors:
                    - jsonPointer: /
                      error: The required properties (name) are missing.
      description: Creates a production
      x-internal: true
      requestBody:
        description: The complete details of the new production to create.
        content:
          application/json:
            schema:
              title: production.post
              type: object
              x-internal: true
              examples:
              - name: Don Vitalski - Gewoon Blijven Ademen
                eventIds:
                - 17c84549-15c5-4dd4-974f-3becdcd952c8
                - 7ee2e70d-78ee-4436-bbcf-1b2ecdd945af
              - name: Kommil Foo - GRIND
                eventIds:
                - 04923b0e-aefc-480b-a1b6-8e5f7ed1d3d6
                - 04e2e6f8-dda1-4531-b4f8-736eecc46f18
                - 0618c6a0-ab16-4c7d-a291-89b495120a39
                - 07fb8c75-5f34-44bc-9e67-ffe20de6cf2b
                - 08d88c9a-2523-4b8f-b774-6f39ed4dcf0e
                - 0dfc2b41-74a6-4cff-ae9b-51300ac611e6
                - 0fd38824-3dac-4b9d-ae15-f5a3951dc282
                - 1492676c-0bce-4245-844e-9bf1643d1a2f
              properties:
                name:
                  type: string
                  description: The name of the production. The name includes the performer and the title of the played piece or event.
                  example: Kommil Foo - GRIND
                eventIds:
                  title: production.eventIds
                  type: string
                  format: uuid
                  description: The event id's that are part of the production
                  examples:
                  - 46e9ea9f-fc42-4759-a81b-4308467b7c35
              required:
              - name
              - eventIds
      tags:
      - Productions
    get:
      summary: productions - search
      description: Get a list of existing productions filtered by a search string
      operationId: productions-get
      responses:
        '200':
          description: Production details
          content:
            application/ld+json:
              schema:
                type: object
                properties:
                  hydra:member:
                    type: array
                    description: Production results for the requested page.
                    items:
                      x-internal: true
                      title: production
                      type: object
                      description: A production that 2 or more events are part of
                      examples:
                      - productionId: c356dac7-133b-4847-805f-91a8c3c09da6
                        name: Alex Agnew speelt 'Wake Me Up When It's Over'
                        events:
                        - 4f37a230-8d8d-4dab-a527-62e879629bae
                        - 7f32b131-deb9-483f-ab32-98541d3c3b77
                        - c41effec-0e04-4e01-8804-9ea9b4c6b528
                      properties:
                        productionId:
                          title: uuid
                          type: string
                          format: uuid
                          description: The uuid of the production
                          examples:
                          - 46e9ea9f-fc42-4759-a81b-4308467b7c35
                        name:
                          type: string
                          description: The title of the production
                          example: Alex Agnew speelt 'Wake Me Up When It's Over'
                        events:
                          type: array
                          description: List of events that are part of the production
                          items:
                            type: string
                      required:
                      - productionId
                      - name
                      - events
              examples:
                Example:
                  value:
                    hydra:member:
                    - productionId: c356dac7-133b-4847-805f-91a8c3c09da6
                      name: Alex Agnew speelt 'Wake Me Up When It's Over'
                      events:
                      - 4f37a230-8d8d-4dab-a527-62e879629bae
                      - 7f32b131-deb9-483f-ab32-98541d3c3b77
                      - c41effec-0e04-4e01-8804-9ea9b4c6b528
            application/json:
              schema:
                type: array
                items:
                  x-internal: true
                  title: production
                  type: object
                  description: A production that 2 or more events are part of
                  examples:
                  - productionId: c356dac7-133b-4847-805f-91a8c3c09da6
                    name: Alex Agnew speelt 'Wake Me Up When It's Over'
                    events:
                    - 4f37a230-8d8d-4dab-a527-62e879629bae
                    - 7f32b131-deb9-483f-ab32-98541d3c3b77
                    - c41effec-0e04-4e01-8804-9ea9b4c6b528
                  properties:
                    productionId:
                      title: uuid
                      type: string
                      format: uuid
                      description: The uuid of the production
                      examples:
                      - 46e9ea9f-fc42-4759-a81b-4308467b7c35
                    name:
                      type: string
                      description: The title of the production
                      example: Alex Agnew speelt 'Wake Me Up When It's Over'
                    events:
                      type: array
                      description: List of events that are part of the production
                      items:
                        type: string
                  required:
                  - productionId
                  - name
                  - events
              examples:
                Example 1:
                  value:
                  - productionId: c356dac7-133b-4847-805f-91a8c3c09da6
                    name: Alex Agnew speelt 'Wake Me Up When It's Over'
                    events:
                    - 4f37a230-8d8d-4dab-a527-62e879629bae
                    - 7f32b131-deb9-483f-ab32-98541d3c3b77
                    - c41effec-0e04-4e01-8804-9ea9b4c6b528
      x-internal: true
      parameters:
      - schema:
          type: string
          minLength: 1
        in: query
        name: name
        description: The name or part of the name of the production(s) to search (case-insensitive).
      - schema:
          type: integer
        in: query
        name: start
        description: The number of productions to skip from the start of the result set. When omitted it starts from the first position (0).
      - schema:
          type: integer
        in: query
        name: limit
        description: The limit of productions included in the result set. When omitted it defaults to 30 items.
      tags:
      - Productions
components:
  parameters:
    productionId1:
      name: productionId1
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
      description: Unique id of a production into which another production is merged, in the format of a UUID
    productionId:
      name: productionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
      description: Unique id of a production
    eventId:
      name: eventId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: F2D5D20C-CC98-4979-9CD2-453ABAD979B5
      description: Unique id of an event, in the format of a UUID
    productionId2:
      name: productionId2
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
      description: Unique id of a production that is merged into another production, in the format of a UUID
  schemas:
    Error:
      title: Error
      type: object
      description: RFC7807 error model for all publiq APIs.
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type. Can be used to recognize specific errors in your application code by comparing the complete URI.
        title:
          type: string
          description: A short, human-readable summary of the problem type (for developers).
        status:
          type: integer
          description: The HTTP status code.
        detail:
          type: string
          description: 'A human-readable explanation specific to this occurrence of the problem (for developers). '
        endUserMessage:
          type: object
          description: A human-readable explanation of the problem, specifically for end-users, in one or more languages. Typically available for domain errors, but not for errors caused by a technical issue in the integration (for example invalid JSON syntax in a request body). An `nl` value is always provided, other languages may be provided depending on the API and its intended audience. When this property is included, it is strongly encouraged to show this to the end-user.
          properties:
            nl:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in Dutch.
            fr:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in French.
            de:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in German.
            en:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in English.
          required:
          - nl
        schemaErrors:
          type: array
          description: A list of one or more schema validation errors (usually used for error type https://api.publiq.be/probs/body/invalid-data).
          items:
            type: object
            properties:
              jsonPointer:
                type: string
                format: json-pointer
                description: RFC6901 compliant pointer that indicates what property/value was invalid.
              error:
                type: string
                description: A human-readable (but often technical) reason why the property was invalid.
            required:
            - jsonPointer
            - error
      required:
      - type
      - title
      - status
      x-internal: false
  responses:
    Forbidden:
      description: 'Forbidden. Your request was successfully authenticated but you do not have permission to perform this particular request.


        * type: https://api.publiq.be/probs/auth/forbidden

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/forbidden
                title: Forbidden
                status: 403
                detail: user must be admin of organizer abcd1234
    Unauthorized:
      description: 'Unauthorized. Your request is missing the required credentials to authenticate. See the Authentication documentation for more info.


        * type: https://api.publiq.be/probs/auth/unauthorized

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/unauthorized
                title: Unauthorized
                status: 401
    NotFound:
      description: 'The requested resource (URL) could not be found.

        This can be due to one of multiple reasons:


        * The endpoint has a typo and/or does not exist on the API

        * One of the path parameters contains a value that is invalid or does not exist

        * One of the required query parameters is missing

        * One of the query parameters has an invalid value


        The `detail` property of the response should contain more specific information.


        The `type` will always be `https://api.publiq.be/probs/url/not-found`.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/url/not-found
                title: URL not found
                status: 404
                detail: The resource with id "76C6AC08-763C-492E-A68C-CBC43A857229" was not found.
  securitySchemes:
    USER_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A user access token, obtained by redirecting the end user to publiq's authorization server to login using the **Authorization Code OAuth Flow**. See the [authentication docs about user access tokens](https://docs.publiq.be/docs/authentication/methods/client-access-token) for more info.
    CLIENT_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A client access token, obtained by exchanging your client id and client secret for a token via an HTTP request to publiq's authorization server using the **Client Credentials OAuth Flow**. See the [authentication docs about client access tokens](https://docs.publiq.be/docs/authentication/methods/user-access-token) for more info.