swagger: '2.0'
info:
  version: '2.0'
  title: roles
consumes:
  - application/json
produces:
  - application/json
paths:
  /roles:
    get:
      tags:
        - roles
      description: Get a collection of roles.
      operationId: getRoles
      parameters:
        - name: id
          in: query
          description: The unique numeric ID for identifying the role.
          required: false
          type: integer
          format: int32
        - name: name
          in: query
          description: The name of the role.
          required: false
          type: string
        - name: description
          in: query
          description: The description of the role.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of roles.
          schema:
            $ref: '#/definitions/RoleCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - roles
      description: Create a role.
      operationId: createRole
      parameters:
        - in: body
          name: Role
          description: The role.
          required: true
          schema:
            $ref: '#/definitions/Role'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/roles/{id}':
    get:
      tags:
        - roles
      description: Get a role.
      operationId: getRoleById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: The role.
          schema:
            $ref: '#/definitions/Role'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - roles
      description: Delete a role.
      operationId: deleteRoleById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - roles
      description: Update a role.
      operationId: updateRoleById
      parameters:
        - in: body
          name: Role
          description: The role.
          required: true
          schema:
            $ref: '#/definitions/Role'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique numeric ID for identifying the role.
        required: true
        type: integer
        format: int32
  '/roles/{id}/role-descriptions':
    get:
      tags:
        - roles
      description: ''
      operationId: getRoleDescriptionsOfRole
      parameters:
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of role descriptions.
          schema:
            $ref: '#/definitions/RoleDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique numeric ID for identifying the role.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  Role:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the role.
      name:
        type: string
        description: The name of the role.
      description:
        type: string
        description: The description of the role.
      links:
        type: object
        description: Links to related resources.
        properties:
          role-descriptions:
            type: object
            description: The role description relationships of a role.
            properties:
              href:
                type: string
                description: The URL of the link.
    description: The role.
  RoleCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/Role'
    description: A collection of roles.
  RoleDescription:
    type: object
    properties:
      roleId:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the role.
      languageId:
        type: integer
        format: int32
        description: 'The language of the description. For a list of integer language identifiers, refer to the Knowledge Center.'
      displayName:
        type: string
        description: The name of the role.
      description:
        type: string
        description: The description of the role.
    description: The role description.
  RoleDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/RoleDescription'
    description: A collection of role descriptions.
