Whiplash Merchandising projects API

Project management and organization.

OpenAPI Specification

whiplash-merchandising-projects-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '2.0'
  title: Rydership bundle_items projects API
  description: 'The Rydership V2 API is open by invite only. Fill out request form <a href="https://help.whiplash.com/hc/en-us/requests/new?ticket_form_id=360001303092"> here</a>.

    <br>

    <a href="api.v2.html">V2 documentation</a>

    <br>

    <a href="api.v2-1.html">V2.1 documentation</a>

    '
  contact:
    name: Rydership Development Team
    email: tech@whiplash.com
    url: https://www.getwhiplash.com
  x-logo:
    url: https://wl-s3-assets.s3.amazonaws.com/rydership/RyderShip-horizontal-safe-padding.svg
    backgroundColor: '#FFFFFF'
    altText: RyderShip
servers:
- url: ''
  description: Base Path
tags:
- name: projects
  description: Project management and organization.
paths:
  /api/v2/projects/{id}/project_tasks:
    get:
      operationId: GetApiV2ProjectsIdProjectTasks
      tags:
      - projects
      summary: List all project_tasks
      description: 'Get a list of project_tasks '
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: search
        in: query
        required: false
        schema:
          type: string
          description: 'JSON search string like {"attribute_eq": "Term"}'
      - name: fields
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list of fields to include in the response
      - name: sort
        in: query
        required: false
        schema:
          type: string
          description: 'A list of sort options (ex: name asc,created_at desc)'
      - name: page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Page of results to fetch
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          format: int32
          description: Number of results to return per page
      - name: page_total
        in: query
        required: false
        schema:
          type: boolean
          description: Include total count of results
      - name: page_links
        in: query
        required: false
        schema:
          type: boolean
          description: Include prev/next links in response headers
      responses:
        '200':
          description: 'Get a list of project_tasks '
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApiV2EntitiesProjectTask'
              examples: null
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
        '403':
          description: forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSharedEntitiesApiError'
components:
  schemas:
    ApiV2EntitiesProjectTask:
      type: object
      title: V2
      properties:
        id:
          type: integer
          format: int32
          description: ''
        project_id:
          type: integer
          format: int32
          description: the project id
        description:
          type:
          - string
          - 'null'
          description: the description of the project task
        label:
          type: string
          description: the type of task, used to determine rates
        quantity:
          type: string
          description: quantity of units
        cost_per_unit:
          type:
          - string
          - 'null'
          description: cost per unit, if task has custom label
        customer_id:
          type: integer
          format: int32
          description: the customer that owns the project and task
        warehouse_id:
          type: integer
          format: int32
          description: the warehouse that owns the project and task
        created_at:
          type: string
          format: date-time
          description: 'project_task created_at '
        updated_at:
          type: string
          format: date-time
          description: 'project_task updated_at '
      additionalProperties: false
    ApiSharedEntitiesApiError:
      type: object
      title: Shared
      properties:
        message:
          type: string
          description: error message
      additionalProperties: false