openapi: 3.2.0
info:
  title: Bynder Metaproperty options operations API
  version: 1.0.0
  description: 'Operations tagged Metaproperty options operations across 2 of this provider''s published API definitions: bynder-metaproperty-options-v4-openapi.json, bynder-options-v4-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{your-bynder-domain}/
security:
- OAuth2:
  - METAPROPERTYMANAGEMENT
  - METAMANAGEMENT
- permanentToken:
  - METAPROPERTYMANAGEMENT
  - METAMANAGEMENT
tags:
- name: Metaproperty options operations
paths:
  /api/v4/metaproperties/options:
    get:
      summary: Retrieve metaproperty options by ids
      tags:
      - Metaproperty options operations
      parameters:
      - name: ids
        in: query
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000
      responses:
        '200':
          description: A list of metaproperty options
          content:
            application/json:
              examples:
                example1:
                  value:
                  - displayLabel: Yellow
                    date: '2017-02-15T14:54:58+00:00'
                    name: yellow
                    id: 00000000-0000-0000-0000000000000000
                    active: 1
                    label: Yellow
                    labels:
                      nl_NL: Geel
                      en_US: Yellow
                  - displayLabel: Red
                    date: '2017-02-15T15:50:55+00:00'
                    name: red
                    id: 00000000-0000-0000-0000000000000000
                    active: 1
                    label: Red
                    labels:
                      nl_NL: Rood
                      en_US: Red
        '400':
          description: Invalid request
          content:
            application/json:
              examples:
                noData:
                  value:
                    message: No data sent
                    statuscode: '400'
                invalidId:
                  value:
                    message: Invalid metaproperty option id sent
                    statuscode: '400'
    servers:
    - url: https://{your-bynder-domain}/
  /api/v4/metaproperties/{id}/options:
    get:
      summary: Retrieve metaproperty options
      tags:
      - Metaproperty options operations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000
      - name: name
        in: query
        required: false
        schema:
          type: string
          example: Amsterdam
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 50
          maximum: 1000
          example: 250
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          example: 1
      - name: externalReference
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    displayLabel:
                      type: string
                      example: Yellow
                    date:
                      type: string
                      format: date-time
                      example: '2017-02-15T14:54:58+00:00'
                    name:
                      type: string
                      example: yellow
                    id:
                      type: string
                      example: 00000000-0000-0000-0000000000000000
                    active:
                      type: integer
                      example: 1
                    label:
                      type: string
                      example: Yellow
                    labels:
                      type: object
                      properties:
                        nl_NL:
                          type: string
                          example: Geel
                        en_US:
                          type: string
                          example: Yellow
              examples:
                example1:
                  value:
                  - displayLabel: Yellow
                    date: '2017-02-15T14:54:58+00:00'
                    name: yellow
                    id: 00000000-0000-0000-0000000000000000
                    active: 1
                    label: Yellow
                    labels:
                      nl_NL: Geel
                      en_US: Yellow
                  - displayLabel: Red
                    date: '2017-02-15T15:50:55+00:00'
                    name: red
                    id: 00000000-0000-0000-0000000000000000
                    active: 1
                    label: Red
                    labels:
                      nl_NL: Rood
                      en_US: Red
        '400':
          description: Invalid metaproperty ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid metaproperty ID
                  statuscode:
                    type: string
                    example: '400'
              examples:
                invalidId:
                  value:
                    message: Invalid metaproperty ID
                    statuscode: '400'
    post:
      summary: Create metaproperty option
      description: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
      tags:
      - Metaproperty options operations
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 00000000-0000-0000-0000000000000000
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                data:
                  type: string
                  description: JSON-serialised string
                  example: '{"name": "BlueType", "externalReference": "Reference number 1", "label": "Blue", "labels": {"fr_FR": "foo", "en_US": "foo"}, "zindex": 4, "isSelectable": true, "parentId": "00000000-0000-0000-0000000000000000", "options": [{"name": "BlueType", "label": "Blue", "labels": {"fr_FR": "foo", "en_US": "foo"}, "zindex": 4, "isSelectable": true, "parentId": "00000000-0000-0000-0000000000000000"}]}'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Created
                  statuscode:
                    type: integer
                    example: 201
                  id:
                    type: string
                    example: 00000000-0000-0000-0000000000000000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid metaproperty ID
                  statuscode:
                    type: string
                    example: '400'
              examples:
                invalidId:
                  value:
                    message: Invalid metaproperty ID
                    statuscode: '400'
                existingOption:
                  value:
                    message: Meta property option with this name already exists
                    existingUUID: 00000000-0000-0000-0000000000000000
                    statuscode: '400'
                nameRequired:
                  value:
                    message: Meta property option name is required
                    statuscode: '400'
                noData:
                  value:
                    message: No data sent
                    statuscode: '400'
                invalidJson:
                  value:
                    message: Invalid JSON
                    statuscode: '400'
        '404':
          description: Metaproperty not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Metaproperty not found
                  statuscode:
                    type: string
                    example: '404'
              examples:
                notFound:
                  value:
                    message: Metaproperty not found
                    statuscode: '404'
    servers:
    - url: https://{your-bynder-domain}/
components:
  securitySchemes:
    permanentToken:
      type: apiKey
      in: header
      name: Authorization
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
          scopes:
            METAPROPERTYMANAGEMENT: ''
            METAMANAGEMENT: ''
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
          scopes:
            METAPROPERTYMANAGEMENT: ''
            METAMANAGEMENT: ''
x-refined-from:
- bynder-metaproperty-options-v4-openapi.json
- bynder-options-v4-openapi.json