#%RAML 0.8
title: Portal API
baseUri: https://api.us1.covisint.com/portal/v2
traits:
- secured:
    usage: Apply this to any method that needs to be secured. Requests with this trait
      require authentication using a bearer token.
    headers:
      Authorization:
        description: Access token that is obtained from the /token endpoint of the
          oauth API.
        pattern: "^Bearer .*$"
        example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk
        required: true
    responses:
      401: &6
        description: Unauthenticated request.  This is returned if the access token
          is missing, invalid, or expired.  Access tokens are obtained through the
          /token endpoint of the Oauth API.
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      403: &7
        description: Unauthorized request.  The requestor is not authorized to perform
          the requested operation.
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
- unsecured:
    usage: Apply this to any method that needs to be unsecured. Requests with this
      trait does not require any authentication.
    headers:
      SolutionInstanceId:
        description: The solution instance id.
        example: ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk
        required: true
    responses:
      400:
        description: Bad request. Please provide the valid solution instance id.
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
- getResponse:
    responses:
      404: &3
        description: |
          The URI requested is invalid or the resource requested does not exist.
          ___
          Substatus codes and error messages are mentioned below:
          + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId}
          + No message for an invalid URI
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      406: &1
        description: |
          Unable to produce content of specified 'Accept' media type
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      500: &2
        description: |
          An unknown server error occurred
          ___
          Substatus codes and error messages are mentioned below:
          + framework:unknown
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
- getSearchResponse:
    responses:
      406: *1
      500: *2
- postResponse:
    responses:
      406: *1
      415: &4
        description: |
          Unable to consume content of specified 'Content-Type' media type
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      500: *2
- deleteResponse:
    responses:
      500: *2
- putResponse:
    responses:
      404: *3
      406: *1
      409: &5
        description: |
          There is a conflict in identifying the resource being acted on.  There are two categories.  (1) The unique identifier in the URL and in the body are different.  (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource.
          + framework:resource:conflict
          + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId}
          + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      415: *4
      500: *2
- putResponseV2:
    responses:
      404: *3
      406: *1
      409:
        description: |
          There is a conflict in identifying the resource being acted on. The unique identifier in the URL and body are different.
          + framework:resource:conflict
          + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId}
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
      415: *4
      500: *2
- putCreateResponse:
    responses:
      406: *1
      409: *5
      415: *4
      500: *2
- taskResponse:
    responses:
      401: *6
      403: *7
      500: *2
- pagableRequest:
    queryParameters:
      page:
        description: Which page to return in the paginated results.  The first page
          is page 1.
        type: integer
        required: false
        minimum: 1
        default: 1
      pageSize:
        description: How many items per page in the paginated results.
        type: integer
        required: false
        minimum: 1
        default: 50
        maximum: 200
- taggable:
    queryParameters:
      tag:
        description: Get the resource based on specified tag. Multiple parameters
          are allowed and the search results will be a union.
        type: string
        required: false
- sortable:
    queryParameters:
      sortBy:
        description: Sort the results based on some criteria.
        example: +creation, -name (These will sort by creation ascending, name descending.
          If "+/-" prefix is omitted, then an ascending sort is assumed).
        type: string
        required: false
- searchable:
    description: Search resources based on the given filter parameters. Search is
      case-insensitive. <<since>> <<entitlement>>
"/dlapp/get-file-entries":
  is:
  - secured
  get:
    responses: {}
    description: |2

      **get-file-entries-2-repositoryId-folderId**
      - repositoryId: integer
      - folderId: integer

      **get-file-entries-3-repositoryId-folderId-fileEntryTypeId**
      - repositoryId: integer
      - folderId: integer
      - fileEntryTypeId: integer

      **get-file-entries-3-repositoryId-folderId-mimeTypes**
      - repositoryId: integer
      - folderId: integer
      - mimeTypes: string

      **get-file-entries-4-repositoryId-folderId-start-end**
      - repositoryId: integer
      - folderId: integer
      - start: integer
      - end: integer

      **get-file-entries-5-repositoryId-folderId-fileEntryTypeId-start-end**
      - repositoryId: integer
      - folderId: integer
      - fileEntryTypeId: integer
      - start: integer
      - end: integer

      **get-file-entries-5-repositoryId-folderId-start-end-obc**
      - repositoryId: integer
      - folderId: integer
      - start: integer
      - end: integer
      - obc: string

      **get-file-entries-6-repositoryId-folderId-fileEntryTypeId-start-end-obc**
      - repositoryId: integer
      - folderId: integer
      - fileEntryTypeId: integer
      - start: integer
      - end: integer
      - obc: string
"/group/get-group":
  is:
  - secured
  get:
    responses: {}
    description: |2

      **get-group-1-groupId**
      - groupId: integer

      **get-group-2-companyId-name**
      - companyId: integer
      - name: string