#%RAML 0.8
title: Push API
baseUri: https://api.us1.covisint.com/broadcast/v1
protocols:
- HTTPS
schemas:
- resourceReferences: "{\n  \"id\" : \"http://api.covisint.com/schema/resourceReferences\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"description\"
    : \"Collection of broadcast templates\",\n  \"type\" : \"array\",\n  \"items\"
    :  { \n    \"$ref\": \"http://api.covisint.com/schema/resourceReference#\"\n  }\n}\n"
- resourceReference: |
    {
      "id" : "http://api.covisint.com/schema/resourceReference",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "description" : "Schema representing links",
      "type" : "object",
      "properties" : {
        "id" : {
          "type" : "string",
          "maxLength" : 36,
          "description" : "The unique identifier for the resource.",
          "required": true
        },
        "type" : {
          "type" : "string",
          "description" : "The type of the resource."
        },
        "realm" : {
          "type" : "string",
          "description" : "The realm of the resource."
        }
      }
    }
- namedResourceReference: "{\n  \"id\" : \"http://api.covisint.com/schema/namedScopedResource\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Expands on the basic resource reference and adds internationalized
    name and description.\",\n  \"extends\" : {\n        \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n
    \ },\n  \"properties\" : {\n     \"name\" : {  \n       \"description\": \"Internationalized
    resource name.\",\n       \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n
    \    },\n     \"description\" : {  \n       \"description\": \"Internationalized
    resource description.\",\n       \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n
    \    }\n   }\n}\n"
- resource: "{\n  \"id\" : \"http://api.covisint.com/schema/resource\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"description\" : \"Core schema\",\n
    \ \"definitions\" : {\n    \"resource\" : {\n      \"id\" : \"resource\",\n      \"type\"
    : \"object\",\n      \"description\" : \"A basic resource.\",\n      \"properties\"
    : {\n        \"id\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The unique identifier for this resource.\",\n
    \         \"required\": true\n        },\n        \"version\": {\n          \"type\"
    : \"number\",\n          \"minimum\" : 0,\n          \"maximum\" : 9223372036854775807,\n
    \         \"description\" : \"The current version for this resource.  Exists once
    the resource has been saved. This is mandatory for PUT requests, but should not
    be supplied for POST requests.\",\n          \"required\": false\n        },\n
    \       \"creator\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The creator of this resource. This is mandatory
    if x-requestor header is NOT available\",\n          \"required\": false\n        },\n
    \       \"creatorAppId\" : {\n          \"type\" : \"string\",\n          \"maxLength\"
    : 64,\n          \"description\" : \"The application id of the creator of this
    resource.\",\n          \"required\": false\n        },\n        \"creation\"
    : {\n          \"type\" : \"number\",\n          \"minimum\" : 0,\n          \"maximum\"
    : 9223372036854775807,\n          \"description\" : \"If this value is provided
    in a POST / PUT request body, it will be ignored and system will generate value
    as time, in milliseconds since the epoch, when this resource was created or upda\",\n
    \         \"required\": false            \n        }\n      }\n    }\n  }\n}\n"
- realmScopedResource: |
    {
      "id" : "http://api.covisint.com/schema/realmScopedResource",
      "$schema" : "http://json-schema.org/draft-04/schema",
      "type" : "object",
      "description" : "Expands on the base resource and adds a realm attribute.",
      "extends" : {
            "$ref" : "http://api.covisint.com/schema/resource#"
      },
      "properties" : {
        "realm" : {
          "type" : "string",
          "maxLength" : 25,
          "pattern" : "^[A-Za-z0-9]{2,25}$",
          "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available",
          "required": false
        }
      }
    }
- errorResponseSchema: "{\n  \"id\" : \"http://api.covisint.com/schema/errorResponseSchema\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Representation of an HTTP 4xx/5xx error response.\",\n  \"properties\"
    : {\n    \"status\" : { \n      \"type\" : \"number\",\n      \"minimum\" : 400,\n
    \     \"maximum\" : 599,\n      \"description\" : \"The HTTP status code.\",\n
    \     \"required\": true\n    },\n    \"apiMessage\" : { \n      \"type\" : \"string\",\n
    \     \"description\" : \"A helpful, human-readable description of the error,
    useful for basic diagnostics.\" \n    },\n    \"apiStatusCode\" : {\n      \"type\"
    : \"string\",\n      \"description\" : \"The API-specific status code.\"\n    }\n\n
    \ }\n}\n"
- serviceCode: "{\n  \"id\" : \"http://api.covisint.com/schema/serviceCodes\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"type\": \"object\",\n  \"description\":
    \"The site/service/location codes granted along with a service.\",\n  \"properties\":
    {\n    \"code\": { \"type\": \"string\", \"required\": true, \"maxLength\": 200,
    \"description\": \"The code value.\" },\n    \"codeKind\": { \"type\": \"string\",
    \"required\": true, \"maxLength\": 36, \"description\": \"The associated business
    unit.\" }\n  }\n}     \n"
- serviceCodes: "{\n  \"type\" : \"array\",\n  \"description\" : \"The site/service/location
    codes granted along with the service, if any.\",\n  \"items\" : { \"$ref\" : \"http://api.covisint.com/schema/serviceCode#\"},\n
    \ \"required\": false\n}\n\n    \n"
- internationalString: |
    {
      "id": "http://api.covisint.com/idm/schema/internationalString",
      "$schema": "http://json-schema.org/draft-04/schema",
      "type": "array",
      "description" : "An internationalized string value, supporting one or more language translations.",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." },
          "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." }
        }
      }
    }
- abstractTaskTargetResource: "{\n  \"id\" : \"http://api.covisint.com/schema/abstractTaskTargetResource\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Expands on the base resource and adds state and error message
    attributes.\",\n  \"extends\" : {\n        \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n
    \ },\n  \"properties\" : {            \n    \"state\" : {\n      \"description\":
    \"The state of the task.\",\n      \"required\": true,\n      \"$ref\" : \"http://api.covisint.com/schema/resourceReferences#\"\n
    \   },\n    \"errorMessage\" : {\n      \"description\": \"Internationalized description.
    Language code must be a valid ISO language code.\",\n      \"required\": false,\n
    \     \"$ref\" : \"http://api.covisint.com/idm/schema/internationalString#\"\n
    \   }\n  }\n}\n \n"
- abstractTaskResource: "{\n  \"id\" : \"http://api.covisint.com/schema/abstractTaskResource\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing a abstract task resource\",\n  \"extends\"
    : {\n        \"$ref\" : \"http://api.covisint.com/schema/resource#\"\n  },\n  \"properties\"
    : {            \n    \"resourceId\" : {\n      \"description\": \"The unique id
    for the resource.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 64\n    },\n    \"claimingThreadId\" : {\n      \"description\":
    \"The claiming thread id.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 128\n    },\n    \"claimedInstant\" : {\n      \"description\":
    \"The instant of claim happened.\",\n      \"required\": false,\n      \"type\"
    : \"number\",\n      \"minimum\" : 0,\n      \"maximum\" : 9223372036854775807\n
    \   },\n    \"retryCount\" : {\n      \"description\": \"The retry count.\",\n
    \     \"required\": false,\n      \"type\" : \"number\",\n      \"minimum\" :
    0,\n      \"maximum\" : 2147483647\n    },\n    \"state\" : {\n      \"description\":
    \"The state of the task.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 16\n    },\n    \"errorMessage\" : {\n      \"description\":
    \"The error message.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 4000\n    },\n    \"priority\" : {\n      \"description\":
    \"priority of the task\",\n      \"required\": false,\n      \"type\" : \"number\",\n
    \     \"minimum\" : 0,\n      \"maximum\" : 2147483647\n    }\n  }\n}\n"
- pushes: "{\n  \"id\" : \"http://api.covisint.com/schema/pushes\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"description\" : \"Collection
    of pushes\",\n  \"type\" : \"array\",\n  \"items\" :  { \n    \"$ref\": \"http://api.covisint.com/schema/push#\"\n
    \ }\n}\n"
- push: "{\n  \"id\" : \"http://api.covisint.com/schema/push\",\n  \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n
    \ \"type\" : \"object\",\n  \"description\" : \"Schema representing a push\",\n
    \ \"extends\" : {\n        \"$ref\" : \"http://api.covisint.com/schema/abstractTaskTargetResource#\"\n
    \ },\n  \"properties\" : {            \n    \"display\" : {\n      \"description\":
    \"The message displayed to the user.\",\n      \"required\": false,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 1000\n    },\n    \"sound\" : {\n      \"description\":
    \"The sound for the push.\",\n      \"required\": false,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n    \"sourceReference\" : {\n      \"description\":
    \"A reference that the sender can set for tracking purposes.\",\n      \"required\":
    false,\n      \"type\":\"string\",\n      \"maxLength\" : 255\n    },\n    \"target\"
    : {\n      \"description\": \" The id of the push target (device) that the push
    is to be sent to.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n     \"type\" : {\n      \"description\": \"
    The type of the push \",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n     \"data\" : {\n      \"description\": \"
    The data of the push\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 100\n    },\n     \"realm\" : {\n      \"description\":
    \" The realm of the push \",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 25\n    },\n    \"statusMessage\": {\n      \"description\":
    \"A status message describing the event of processing the push queue item. Mainly
    used for error conditions.\",\n      \"required\": false,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 1000\n    },\n    \"processed\" : {\n      \"description\":
    \"The instant that the push was processed.\",\n      \"required\": false,\n      \"type\"
    : \"number\",\n      \"minimum\" : 0,\n      \"maximum\" : 9223372036854775807\n
    \   }\n  }\n}\n"
- pushApplicationTags: "{\n  \"id\" : \"http://api.covisint.com/schema/pushApplicationTags\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"description\"
    : \"Collection of Push Application Tags\",\n  \"type\" : \"array\",\n  \"items\"
    :  { \n    \"$ref\": \"http://api.covisint.com/schema/pushApplicationsTag#\"\n
    \ }\n}\n"
- pushApplicationsTag: "{\n  \"id\" : \"http://api.covisint.com/schema/pushApplicationsTag\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing a Push Application Tag\",\n  \"extends\"
    : {\n        \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {            \n    \"tag\" : {\n      \"description\":
    \"The tag for push application.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n    \"pushApplication\" : {\n      \"description\":
    \"The push application associated with.\",\n      \"required\": true,\n      \"$ref\"
    : \"http://api.covisint.com/schema/pushApplication#\"\n    }\n  }\n}\n"
- pushApplication: "{\n  \"id\" : \"http://api.covisint.com/schema/pushApplication\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing a Push Application\",\n  \"extends\"
    : {\n        \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {            \n    \"apnCertificateName\" : {\n      \"description\":
    \"APN certificate name.  This will be the name of the file.\",\n      \"required\":
    false,\n      \"type\":\"string\",\n      \"maxLength\" : 255\n    },\n    \"apnCertificateExpirationDate\"
    : {\n      \"description\": \"Production APN certificate expiration date.\",\n
    \     \"type\" : \"number\",\n      \"minimum\" : 0,\n      \"maximum\" : 9223372036854775807\n
    \   },\n    \"apnCertificatePassword\" : {\n      \"description\": \"Production
    APN certificate password.\",\n      \"required\": false,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n    \"applicationName\" : {\n      \"description\":
    \"Application name, as reported to Google/iOS.\",\n      \"required\": true,\n
    \     \"type\":\"string\",\n      \"maxLength\" : 255\n    },\n    \"providerAppId\"
    : {\n      \"description\": \"Provider Application id, as reported to Google/iOS.\",\n
    \     \"required\": false,\n      \"type\":\"string\",\n      \"maxLength\" :
    255\n    },\n    \"gcmToken\" : {\n      \"description\": \"The token used for
    pushing to Android devices.\",\n      \"required\": false,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 255\n    },\n    \"pushApplicationTags\" : {\n      \"description\":
    \"The token used for pushing to Android devices.\",\n      \"required\": false,\n
    \     \"$ref\" : \"http://api.covisint.com/schema/pushApplicationTags#\"\n    }\n
    \ }\n}\n"
- pushTargets: "{\n  \"id\" : \"http://api.covisint.com/schema/pushTargets\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"description\" : \"Collection
    of push targets\",\n  \"type\" : \"array\",\n  \"items\" :  { \n    \"$ref\":
    \"http://api.covisint.com/schema/pushTarget#\"\n  }\n}\n"
- pushTarget: "{\n  \"id\" : \"http://api.covisint.com/schema/pushTarget\",\n  \"$schema\"
    : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n  \"description\"
    : \"Schema representing a push target\",\n  \"extends\" : {\n        \"$ref\"
    : \"http://api.covisint.com/schema/realmScopedResource#\"\n  },\n  \"properties\"
    : {            \n    \"deviceId\" : {\n      \"description\": \"The device id.\",\n
    \     \"required\": true,\n      \"type\":\"string\",\n      \"maxLength\" : 255\n
    \   },\n    \"deviceName\" : {\n      \"description\": \"The device name.\",\n
    \     \"required\": false,\n      \"type\":\"string\",\n      \"maxLength\" :
    255\n    },\n    \"token\" : {\n      \"description\": \"The token for push.\",\n
    \     \"required\": true,\n      \"type\":\"string\",\n      \"maxLength\" : 255\n
    \   },\n    \"Type\" : {\n      \"description\": \"The Sting denotes the type
    of push target. Either Google/iOS.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 10\n    },\n    \"PushApplication\" : {\n      \"description\":
    \"The application of the push application this push target is for.\",\n      \"required\":
    true,\n      \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n
    \   }\n  }\n}\n"
- messageTarget: "{\n  \"id\" : \"http://api.covisint.com/schema/messageTarget\",\n
    \ \"$schema\" : \"http://json-schema.org/draft-04/schema\",\n  \"type\" : \"object\",\n
    \ \"description\" : \"Schema representing a message target\",\n  \"extends\" :
    {\n        \"$ref\" : \"http://api.covisint.com/schema/realmScopedResource#\"\n
    \ },\n  \"properties\" : {            \n    \"person\" : {\n      \"description\":
    \"The user associated with.\",\n      \"required\": true,\n      \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n
    \   },\n    \"userPreference\" : {\n      \"description\": \"The preference of
    the user for this target.\",\n      \"required\": true,\n      \"type\":\"string\",\n
    \     \"maxLength\" : 20\n    },\n    \"type\" : {\n      \"description\": \"The
    type of the message target.  It represents the way the message gets delivered.\",\n
    \     \"required\": true,\n      \"type\":\"string\",\n      \"maxLength\" : 20\n
    \   },\n    \"target\" : {\n      \"description\": \"The ID of the target that
    receives the message.  This could be a email target id, push target id, etc.\",\n
    \     \"required\": true,\n      \"$ref\" : \"http://api.covisint.com/schema/resourceReference#\"\n
    \   },\n    \"clientId\" : {\n      \"description\": \"The client id\",\n      \"required\":
    false,\n      \"type\":\"string\",\n      \"maxLength\" : 255\n    }\n  }\n}\n"
traits:
- secured:
    usage: Apply this to any method that needs to be secured
    description: Requests requires 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:
        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:
        description: Unauthorized request.  The requestor is not authorized to perform
          the requested operation.
        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
- putCreateResponse:
    responses:
      406: *1
      409: *5
      415: *4
      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
"/push":
  is:
  - secured
  description: Collection endpoint for push.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search pushes .
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.push.v1+json;
        type: string
        required: true
    queryParameters: 
    responses:
      200:
        description: All pushes were successfully retrieved (response collection may
          be empty).
        body:
          application/vnd.com.covisint.platform.push.v1+json:
            schema: push
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  post:
    is:
    - postResponse
    description: Creates a new push.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.push.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.push.v1+json:
        schema: push
    responses:
      201:
        description: A new push was created.
        body:
          application/vnd.com.covisint.platform.push.v1+json:
            schema: push
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          + puh:target:invalid - Push target with id (targetId) does not exists;
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{pushId}":
    description: Endpoint for a push.
    uriParameters: 
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a push by its unique identifier.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.push.v1+json
          type: string
          required: true
      responses:
        200:
          description: The push was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.push.v1+json:
              schema: push
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
  "/types":
    description: Endpoint for a push.
    uriParameters: 
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a push by its type and user id.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.push.v1+json
          type: string
          required: true
      responses:
        200:
          description: The push was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.push.v1+json:
              schema: push
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
"/pushApplications":
  is:
  - secured
  description: Collection endpoint for pushApplications.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search pushApplications based on the given filter parameters.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushApplication.v1+json;
        type: string
        required: true
    queryParameters:
      tags:
        description: Retrieve only pushApplications with the specified owner id.
        type: string
        required: true
    responses:
      200:
        description: All pushApplications that satisfy the query parameters were successfully
          retrieved (response collection may be empty).
        body:
          application/vnd.com.covisint.platform.pushApplication.v1+json:
            schema: pushApplications
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  post:
    is:
    - postResponse
    description: Adds a new pushApplication.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushApplication.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.pushApplication.v1+json:
        schema: pushApplication
    responses:
      201:
        description: The pushApplication was successfully created.
        body:
          application/vnd.com.covisint.platform.pushApplication.v1+json:
            schema: pushApplication
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{pushApplicationId}":
    description: Endpoint for a push application.
    uriParameters:
      pushApplicationId:
        description: Unique identifier for the push application.
        type: string
        required: true
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a push application by its unique identifier.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.pushApplication.v1+json
          type: string
          required: true
      responses:
        200:
          description: The push application was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.pushApplication.v1+json:
              schema: pushApplication
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    put:
      is:
      - putResponse
      description: Updates an existing push application.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.pushApplication.v1+json
          type: string
          required: true
      body:
        application/vnd.com.covisint.platform.pushApplication.v1+json:
          schema: pushApplication
      responses:
        200:
          description: The push application was successfully updated.
          body:
            application/vnd.com.covisint.platform.pushApplication.v1+json:
              schema: pushApplication
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes and error messages are mentioned below:
            + framework:request
            + framework:request:io
            + framework:request:io:read - Invalid input. There was an error while parsing.
            + framework:request:io:read:parsing
            + framework:request:io:write
            + framework:request:header:missing - Missing request header: {headerName}
            + framework:request:param:missing - Missing request parameter: {queryParameterName}
            + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    delete:
      is:
      - deleteResponse
      description: Deletes a push application.
      headers: 
      responses:
        204:
          description: The push application was successfully deleted.
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes are mentioned below:
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
"/pushApplicationTag":
  is:
  - secured
  description: Collection endpoint for push application tags.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search push application tags based on the given filter parameters.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushApplicationTag.v1+json
        type: string
        required: true
    queryParameters:
      userId:
        description: Retrieve only push application tags with the specified owner
          id.
        type: string
        required: true
    responses:
      200:
        description: All push application tags that satisfy the query parameters were
          successfully retrieved (response collection may be empty).
        body:
          application/vnd.com.covisint.platform.pushApplicationTag.v1+json:
            schema: pushApplicationTags
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  post:
    is:
    - postResponse
    description: Adds a new push application tag.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushApplicationTag.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.pushApplicationTag.v1+json:
        schema: pushApplicationTag
    responses:
      201:
        description: The new push application tag was successfully created.
        body:
          application/vnd.com.covisint.platform.pushApplicationTag.v1+json:
            schema: pushApplicationTag
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          + push:application:invalid - Push application with id (pushApplicationId) does not exists;
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{pushApplicationTagId}":
    description: Endpoint for a new push application tag.
    uriParameters:
      pushApplicationTagId:
        description: Unique identifier for the new push application tag.
        type: string
        required: true
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a new push application tag by its unique identifier.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.pushApplicationTag.v1+json
          type: string
          required: true
      responses:
        200:
          description: The new push application tag was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.pushApplicationTag.v1+json:
              schema: pushApplicationTag
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    delete:
      is:
      - deleteResponse
      description: Deletes a new push application tag.
      headers: 
      responses:
        204:
          description: The new push application tag was successfully deleted.
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes are mentioned below:
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
"/pushTargets":
  is:
  - secured
  description: Collection endpoint for push targets.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search push targets based on the given filter parameters.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushTarget.v1+json
        type: string
        required: true
    queryParameters:
      token:
        description: Retrieve only pushTargets with the specified owner id.
        type: string
        required: true
    responses:
      200:
        description: All pushTargets that satisfy the query parameters were successfully
          retrieved (response collection may be empty).
        body:
          application/vnd.com.covisint.platform.pushTarget.v1+json:
            schema: pushTargets
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  post:
    is:
    - postResponse
    description: Adds a new push target.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.pushTarget.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.pushTarget.v1+json:
        schema: pushTarget
    responses:
      201:
        description: The push target was successfully created.
        body:
          application/vnd.com.covisint.platform.pushTarget.v1+json:
            schema: pushTarget
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{pushTargetId}":
    description: Endpoint for a push target.
    uriParameters:
      pushTargetId:
        description: Unique identifier for the push target.
        type: string
        required: true
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a push target by its unique identifier.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.pushTarget.v1+json
          type: string
          required: true
      responses:
        200:
          description: The push target was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.pushTarget.v1+json:
              schema: pushTarget
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    put:
      is:
      - putResponse
      description: Updates an existing push target.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.pushTarget.v1+json
          type: string
          required: true
      body:
        application/vnd.com.covisint.platform.pushTarget.v1+json:
          schema: pushTarget
      responses:
        200:
          description: The push target was successfully updated.
          body:
            application/vnd.com.covisint.platform.pushTarget.v1+json:
              schema: pushTarget
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes and error messages are mentioned below:
            + framework:request
            + framework:request:io
            + framework:request:io:read - Invalid input. There was an error while parsing.
            + framework:request:io:read:parsing
            + framework:request:io:write
            + framework:request:header:missing - Missing request header: {headerName}
            + framework:request:param:missing - Missing request parameter: {queryParameterName}
            + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    delete:
      is:
      - deleteResponse
      description: Deletes a push target.
      headers: 
      responses:
        204:
          description: The push target was successfully deleted.
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes are mentioned below:
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
"/messageTargets":
  is:
  - secured
  description: Collection endpoint for message targets.
  get:
    is:
    - getSearchResponse
    - pagableRequest
    description: Search message targets based on the given filter parameters.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.messageTarget.v1+json
        type: string
        required: true
    queryParameters:
      targetId:
        description: Retrieve only messageTargets with the specified target id.
        type: string
        required: true
      clientId:
        description: Retrieve only messageTargets with the specified client id.
        type: string
        required: true
    responses:
      200:
        description: All messageTargets that satisfy the query parameters were successfully
          retrieved (response collection may be empty).
        body:
          application/vnd.com.covisint.platform.messageTarget.v1+json:
            schema: messageTargets
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  post:
    is:
    - postResponse
    description: Adds a new message target.
    headers:
      Accept:
        description: Media type.
        example: application/vnd.com.covisint.platform.messageTarget.v1+json
        type: string
        required: true
    body:
      application/vnd.com.covisint.platform.messageTarget.v1+json:
        schema: messageTarget
    responses:
      201:
        description: The message target was successfully created.
        body:
          application/vnd.com.covisint.platform.messageTarget.v1+json:
            schema: messageTarget
      400:
        description: |
          There was a problem with the client's request
          ___
          Substatus codes and error messages are mentioned below:
          + framework:request
          + framework:request:io
          + framework:request:io:read - Invalid input. There was an error while parsing.
          + framework:request:io:read:parsing
          + framework:request:io:write
          + framework:request:header:missing - Missing request header: {headerName}
          + framework:request:param:missing - Missing request parameter: {queryParameterName}
          + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
          + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName}
          + framework:resource:data:illegal - The following information was illegal from the resource:  {fieldSpecificError(s)}
          + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          + target.push.invalid - Target for the type(targetType) with id does not exists;
          + target.duplicate - Message Target with target id (targetId) is alreadyexists;
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  "/{messageTargetId}":
    description: Endpoint for a message target.
    uriParameters:
      messageTargetId:
        description: Unique identifier for the message target.
        type: string
        required: true
    is:
    - secured
    get:
      is:
      - getResponse
      description: Returns a message target by its unique identifier.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.messageTarget.v1+json
          type: string
          required: true
      responses:
        200:
          description: The message target was successfully retrieved.
          body:
            application/vnd.com.covisint.platform.messageTarget.v1+json:
              schema: messageTarget
        400:
          description: "There was a problem with the client's request\n___\nSubstatus codes are mentioned below:\n+ framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] \n"
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    put:
      is:
      - putResponse
      description: Updates an existing message target.
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.messageTarget.v1+json
          type: string
          required: true
      body:
        application/vnd.com.covisint.platform.messageTarget.v1+json:
          schema: messageTarget
      responses:
        200:
          description: The message target was successfully updated.
          body:
            application/vnd.com.covisint.platform.messageTarget.v1+json:
              schema: messageTarget
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes and error messages are mentioned below:
            + framework:request
            + framework:request:io
            + framework:request:io:read - Invalid input. There was an error while parsing.
            + framework:request:io:read:parsing
            + framework:request:io:write
            + framework:request:header:missing - Missing request header: {headerName}
            + framework:request:param:missing - Missing request parameter: {queryParameterName}
            + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema
    delete:
      is:
      - deleteResponse
      description: Deletes a message target.
      headers: 
      responses:
        204:
          description: The message target was successfully deleted.
        400:
          description: |
            There was a problem with the client's request
            ___
            Substatus codes are mentioned below:
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema