API Reference

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

apps

list

GET /apps/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action apps list -p limit=... -p offset=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["apps", "list"]
var params = {
    limit: ...,
    offset: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["apps", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

read

GET /apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action apps read -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["apps", "read"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["apps", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

auth

create

POST /auth/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`consumer_key` required	Valid consumer key for authentication
`consumer_secret` required	Valid consumer secret for authentication

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action auth create -p consumer_key=... -p consumer_secret=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "create"]
var params = {
    consumer_key: ...,
    consumer_secret: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["auth", "create"]
params = {
    "consumer_key": ...,
    "consumer_secret": ...,
}
result = client.action(schema, action, params=params)

device > create

POST /auth/device/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`udid` required	Valid device identifier for authentication
`md5` required	Valid device secret for authentication

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action auth device create -p udid=... -p md5=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "device &gt; create"]
var params = {
    udid: ...,
    md5: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["auth", "device &gt; create"]
params = {
    "udid": ...,
    "md5": ...,
}
result = client.action(schema, action, params=params)

ipaduser > create

POST /auth/ipaduser/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Valid username for authentication
`password` required	Valid password for authentication

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action auth ipaduser create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "ipaduser &gt; create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["auth", "ipaduser &gt; create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

user > create

POST /auth/user/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Valid username for authentication
`password` required	Valid password for authentication

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action auth user create -p username=... -p password=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["auth", "user &gt; create"]
var params = {
    username: ...,
    password: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["auth", "user &gt; create"]
params = {
    "username": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

Parameter	Description
`category_name` required	Name of your choice to be displayed in the interface.
`app` required	An integer value identifying the app.
`parent_category` required	An integer value identifying the parent category. Use `0` for main categories, `-1` for subcategories without parent relation.
`related_type`	Association of category to file types. It can be empty for all file types, or one of the following string values: `pdf`, `presentation`, `video`, `surveys`, `zip`.
`order_value`	Order of category in categories list.

Parameter	Description
`id` required	A unique integer value identifying this category.

Parameter	Description
`id` required	A unique integer value identifying this category.

Parameter	Description
`category_name` required	Name of your choice to be displayed in the interface.
`app` required	An integer value identifying the app.
`parent_category` required	An integer value identifying the parent category. Use `0` for main categories, `-1` for subcategories without parent relation.
`related_type`	Association of category to file types. It can be empty for all file types, or one of the following string values: `pdf`, `presentation`, `video`, `surveys`, `zip`.
`order_value`	Order of category in categories list.

Parameter	Description
`id` required	A unique integer value identifying this category.

Parameter	Description
`category_name`	Name of your choice to be displayed in the interface.
`app`	An integer value identifying the app.
`parent_category`	An integer value identifying the parent category. Use `0` for main categories, `-1` for subcategories without parent relation.
`related_type`	Association of category to file types. It can be empty for all file types, or one of the following string values: `pdf`, `presentation`, `video`, `surveys`, `zip`.
`order_value`	Order of category in categories list.

Parameter	Description
`id` required	A unique integer value identifying this category.

device-users

create

POST /device-users/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`password` required
`udid` required

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action device-users create -p username=... -p password=... -p udid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["device-users", "create"]
var params = {
    username: ...,
    password: ...,
    udid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["device-users", "create"]
params = {
    "username": ...,
    "password": ...,
    "udid": ...,
}
result = client.action(schema, action, params=params)

read

GET /device-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this i pad user.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action device-users read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["device-users", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["device-users", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update

PUT /device-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this i pad user.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required
`password` required
`udid` required

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action device-users update -p id=... -p username=... -p password=... -p udid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["device-users", "update"]
var params = {
    id: ...,
    username: ...,
    password: ...,
    udid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["device-users", "update"]
params = {
    "id": ...,
    "username": ...,
    "password": ...,
    "udid": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /device-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this i pad user.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`
`password`
`udid`

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action device-users partial_update -p id=... -p username=... -p password=... -p udid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["device-users", "partial_update"]
var params = {
    id: ...,
    username: ...,
    password: ...,
    udid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["device-users", "partial_update"]
params = {
    "id": ...,
    "username": ...,
    "password": ...,
    "udid": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /device-users/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this i pad user.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action device-users delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["device-users", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["device-users", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

devices

list

GET /devices/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`ordering`	Which field to use when ordering the results.
`search`	A search term.
`app`
`metadata`
`udid`	A unique device identifier.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices list -p limit=... -p offset=... -p ordering=... -p search=... -p app=... -p metadata=... -p udid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "list"]
var params = {
    limit: ...,
    offset: ...,
    ordering: ...,
    search: ...,
    app: ...,
    metadata: ...,
    udid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "ordering": ...,
    "search": ...,
    "app": ...,
    "metadata": ...,
    "udid": ...,
}
result = client.action(schema, action, params=params)

create

POST /devices/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`apps` required
`device_name` required
`device_user`
`metadata`
`udid` required

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices create -p apps=... -p device_name=... -p device_user=... -p metadata=... -p udid=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "create"]
var params = {
    apps: ...,
    device_name: ...,
    device_user: ...,
    metadata: ...,
    udid: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "create"]
params = {
    "apps": ...,
    "device_name": ...,
    "device_user": ...,
    "metadata": ...,
    "udid": ...,
}
result = client.action(schema, action, params=params)

read

GET /devices/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this device.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices read -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "read"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

update

PUT /devices/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this device.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`apps` required
`device_name` required
`device_user`
`metadata`
`udid` required

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices update -p id=... -p apps=... -p device_name=... -p device_user=... -p metadata=... -p udid=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "update"]
var params = {
    id: ...,
    apps: ...,
    device_name: ...,
    device_user: ...,
    metadata: ...,
    udid: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "update"]
params = {
    "id": ...,
    "apps": ...,
    "device_name": ...,
    "device_user": ...,
    "metadata": ...,
    "udid": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /devices/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this device.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`apps`
`device_name`
`device_user`
`metadata`
`udid`

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices partial_update -p id=... -p apps=... -p device_name=... -p device_user=... -p metadata=... -p udid=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "partial_update"]
var params = {
    id: ...,
    apps: ...,
    device_name: ...,
    device_user: ...,
    metadata: ...,
    udid: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "partial_update"]
params = {
    "id": ...,
    "apps": ...,
    "device_name": ...,
    "device_user": ...,
    "metadata": ...,
    "udid": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /devices/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this device.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices delete -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "delete"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

history > list

GET /devices/history/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`history_type`	Show items with type added, changed or deleted.
`app`	An integer value identifying an app.
`history_date__gte`	Show items created greater than or equal to a time value.
`ordering`	Which field to use when ordering the results.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices history list -p limit=... -p offset=... -p history_type=... -p app=... -p history_date__gte=... -p ordering=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices", "history &gt; list"]
var params = {
    limit: ...,
    offset: ...,
    history_type: ...,
    app: ...,
    history_date__gte: ...,
    ordering: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices", "history &gt; list"]
params = {
    "limit": ...,
    "offset": ...,
    "history_type": ...,
    "app": ...,
    "history_date__gte": ...,
    "ordering": ...,
}
result = client.action(schema, action, params=params)

devices-apps

list

GET /devices-apps/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`app`	An integer value identifying the app.
`device`	An integer value identifying the device.
`is_test`	Mark as test device.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices-apps list -p limit=... -p offset=... -p app=... -p device=... -p is_test=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices-apps", "list"]
var params = {
    limit: ...,
    offset: ...,
    app: ...,
    device: ...,
    is_test: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices-apps", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "app": ...,
    "device": ...,
    "is_test": ...,
}
result = client.action(schema, action, params=params)

create

POST /devices-apps/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app` required	An integer value identifying the app.
`device` required	An integer value identifying the device.
`is_test`	Mark as test device.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices-apps create -p app=... -p device=... -p is_test=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices-apps", "create"]
var params = {
    app: ...,
    device: ...,
    is_test: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices-apps", "create"]
params = {
    "app": ...,
    "device": ...,
    "is_test": ...,
}
result = client.action(schema, action, params=params)

update

PUT /devices-apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app device.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app` required	An integer value identifying the app.
`device` required	An integer value identifying the device.
`is_test`	Mark as test device.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices-apps update -p id=... -p app=... -p device=... -p is_test=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices-apps", "update"]
var params = {
    id: ...,
    app: ...,
    device: ...,
    is_test: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices-apps", "update"]
params = {
    "id": ...,
    "app": ...,
    "device": ...,
    "is_test": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /devices-apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app device.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`app`	An integer value identifying the app.
`device`	An integer value identifying the device.
`is_test`	Mark as test device.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices-apps partial_update -p id=... -p app=... -p device=... -p is_test=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices-apps", "partial_update"]
var params = {
    id: ...,
    app: ...,
    device: ...,
    is_test: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices-apps", "partial_update"]
params = {
    "id": ...,
    "app": ...,
    "device": ...,
    "is_test": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /devices-apps/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this app device.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action devices-apps delete -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["devices-apps", "delete"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["devices-apps", "delete"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

distributions

create

POST /distributions/

Nobody has the permission to create or update distributions directly. You can use the files parameter distribution.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`cover_new_devices`	Distribute to all (including new) devices and groups.
`expiration_date`
`start_date`
`devices`	An array of device identifiers.
`groups`	An array of string values.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action distributions create -p cover_new_devices=... -p expiration_date=... -p start_date=... -p devices=... -p groups=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["distributions", "create"]
var params = {
    cover_new_devices: ...,
    expiration_date: ...,
    start_date: ...,
    devices: ...,
    groups: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["distributions", "create"]
params = {
    "cover_new_devices": ...,
    "expiration_date": ...,
    "start_date": ...,
    "devices": ...,
    "groups": ...,
}
result = client.action(schema, action, params=params)

update

PUT /distributions/{id}/

Nobody has the permission to create or update distributions directly. You can use the files parameter distribution.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this distribution.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`cover_new_devices`	Distribute to all (including new) devices and groups.
`expiration_date`
`start_date`
`devices`	An array of device identifiers.
`groups`	An array of string values.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action distributions update -p id=... -p cover_new_devices=... -p expiration_date=... -p start_date=... -p devices=... -p groups=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["distributions", "update"]
var params = {
    id: ...,
    cover_new_devices: ...,
    expiration_date: ...,
    start_date: ...,
    devices: ...,
    groups: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["distributions", "update"]
params = {
    "id": ...,
    "cover_new_devices": ...,
    "expiration_date": ...,
    "start_date": ...,
    "devices": ...,
    "groups": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /distributions/{id}/

Nobody has the permission to create or update distributions directly. You can use the files parameter distribution.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this distribution.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`cover_new_devices`	Distribute to all (including new) devices and groups.
`expiration_date`
`start_date`
`devices`	An array of device identifiers.
`groups`	An array of string values.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action distributions partial_update -p id=... -p cover_new_devices=... -p expiration_date=... -p start_date=... -p devices=... -p groups=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["distributions", "partial_update"]
var params = {
    id: ...,
    cover_new_devices: ...,
    expiration_date: ...,
    start_date: ...,
    devices: ...,
    groups: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["distributions", "partial_update"]
params = {
    "id": ...,
    "cover_new_devices": ...,
    "expiration_date": ...,
    "start_date": ...,
    "devices": ...,
    "groups": ...,
}
result = client.action(schema, action, params=params)

files

list

GET /files/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`limit`	Number of results to return per page.
`offset`	The initial index from which to return the results.
`app` required	An integer value identifying the app.
`ordering`	Which field to use when ordering the results.
`search`	A search term.
`keywords[]`	An array of string values.
`filename`
`status`

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files list -p limit=... -p offset=... -p app=... -p ordering=... -p search=... -p keywords[]=... -p filename=... -p status=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "list"]
var params = {
    limit: ...,
    offset: ...,
    app: ...,
    ordering: ...,
    search: ...,
    keywords[]: ...,
    filename: ...,
    status: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "list"]
params = {
    "limit": ...,
    "offset": ...,
    "app": ...,
    "ordering": ...,
    "search": ...,
    "keywords[]": ...,
    "filename": ...,
    "status": ...,
}
result = client.action(schema, action, params=params)

create

POST /files/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`body` required	Name of your choice to be displayed in the interface.
`keywords`	Keywords separated by commas: `Switzerland, French`
`type`
`filename`	Name of this file in storage.
`status`
`extra`	Number of slides in a presentation or pages in a PDF.
`creation_time`	Time at which the file was created.
`extra2`	Bits separated by a vertical line enabling a presentation to be used in custom decks, `print\|mail` for PDFs and `fullscreen\|portrait` for ZIP-Archives.
`category`	Category of file. Valid values: 'json', 'pdf', 'presentation', 'video', 'zip', ''
`app` required	A unique integer value identifying this file's application.
`push_notification_text`	Text sent to devices to inform about the new file.
`year`	Set to `1` to show the first two pages of a PDF.
`distribution`	See distributions.
`metadata`	An object with key and value pairs: `{"key": "value"}`.
`download_url`	The download URL of the input file.
`download_ext`	Download file extension (including point) if not included in the download URL.
`download_bearer`	Download bearer token.
`download_auth`	Download authorization header value.
`skip_conversion`	Should set to true if created file shouldn't be converted
`file`
`download_payload`	Download url payload data value as a string.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files create -p body=... -p keywords=... -p type=... -p filename=... -p status=... -p extra=... -p creation_time=... -p extra2=... -p category=... -p app=... -p push_notification_text=... -p year=... -p distribution=... -p metadata=... -p download_url=... -p download_ext=... -p download_bearer=... -p download_auth=... -p skip_conversion=... -p file=... -p download_payload=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "create"]
var params = {
    body: ...,
    keywords: ...,
    type: ...,
    filename: ...,
    status: ...,
    extra: ...,
    creation_time: ...,
    extra2: ...,
    category: ...,
    app: ...,
    push_notification_text: ...,
    year: ...,
    distribution: ...,
    metadata: ...,
    download_url: ...,
    download_ext: ...,
    download_bearer: ...,
    download_auth: ...,
    skip_conversion: ...,
    file: ...,
    download_payload: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "create"]
params = {
    "body": ...,
    "keywords": ...,
    "type": ...,
    "filename": ...,
    "status": ...,
    "extra": ...,
    "creation_time": ...,
    "extra2": ...,
    "category": ...,
    "app": ...,
    "push_notification_text": ...,
    "year": ...,
    "distribution": ...,
    "metadata": ...,
    "download_url": ...,
    "download_ext": ...,
    "download_bearer": ...,
    "download_auth": ...,
    "skip_conversion": ...,
    "file": ...,
    "download_payload": ...,
}
result = client.action(schema, action, params=params)

read

GET /files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files read -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "read"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "read"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

update

PUT /files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`body` required	Name of your choice to be displayed in the interface.
`keywords`	Keywords separated by commas: `Switzerland, French`
`type`
`filename`	Name of this file in storage.
`status`
`extra`	Number of slides in a presentation or pages in a PDF.
`creation_time`	Time at which the file was created.
`extra2`	Bits separated by a vertical line enabling a presentation to be used in custom decks, `print\|mail` for PDFs and `fullscreen\|portrait` for ZIP-Archives.
`category`	Category of file. Valid values: 'json', 'pdf', 'presentation', 'video', 'zip', ''
`app` required	A unique integer value identifying this file's application.
`push_notification_text`	Text sent to devices to inform about the new file.
`year`	Set to `1` to show the first two pages of a PDF.
`distribution`	See distributions.
`metadata`	An object with key and value pairs: `{"key": "value"}`.
`download_url`	The download URL of the input file.
`download_ext`	Download file extension (including point) if not included in the download URL.
`download_bearer`	Download bearer token.
`download_auth`	Download authorization header value.
`skip_conversion`	Should set to true if created file shouldn't be converted
`file`
`download_payload`	Download url payload data value as a string.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files update -p id=... -p body=... -p keywords=... -p type=... -p filename=... -p status=... -p extra=... -p creation_time=... -p extra2=... -p category=... -p app=... -p push_notification_text=... -p year=... -p distribution=... -p metadata=... -p download_url=... -p download_ext=... -p download_bearer=... -p download_auth=... -p skip_conversion=... -p file=... -p download_payload=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "update"]
var params = {
    id: ...,
    body: ...,
    keywords: ...,
    type: ...,
    filename: ...,
    status: ...,
    extra: ...,
    creation_time: ...,
    extra2: ...,
    category: ...,
    app: ...,
    push_notification_text: ...,
    year: ...,
    distribution: ...,
    metadata: ...,
    download_url: ...,
    download_ext: ...,
    download_bearer: ...,
    download_auth: ...,
    skip_conversion: ...,
    file: ...,
    download_payload: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "update"]
params = {
    "id": ...,
    "body": ...,
    "keywords": ...,
    "type": ...,
    "filename": ...,
    "status": ...,
    "extra": ...,
    "creation_time": ...,
    "extra2": ...,
    "category": ...,
    "app": ...,
    "push_notification_text": ...,
    "year": ...,
    "distribution": ...,
    "metadata": ...,
    "download_url": ...,
    "download_ext": ...,
    "download_bearer": ...,
    "download_auth": ...,
    "skip_conversion": ...,
    "file": ...,
    "download_payload": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`body`	Name of your choice to be displayed in the interface.
`keywords`	Keywords separated by commas: `Switzerland, French`
`type`
`filename`	Name of this file in storage.
`status`
`extra`	Number of slides in a presentation or pages in a PDF.
`creation_time`	Time at which the file was created.
`extra2`	Bits separated by a vertical line enabling a presentation to be used in custom decks, `print\|mail` for PDFs and `fullscreen\|portrait` for ZIP-Archives.
`category`	Category of file. Valid values: 'json', 'pdf', 'presentation', 'video', 'zip', ''
`app`	A unique integer value identifying this file's application.
`push_notification_text`	Text sent to devices to inform about the new file.
`year`	Set to `1` to show the first two pages of a PDF.
`distribution`	See distributions.
`metadata`	An object with key and value pairs: `{"key": "value"}`.
`download_url`	The download URL of the input file.
`download_ext`	Download file extension (including point) if not included in the download URL.
`download_bearer`	Download bearer token.
`download_auth`	Download authorization header value.
`skip_conversion`	Should set to true if created file shouldn't be converted
`file`
`download_payload`	Download url payload data value as a string.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files partial_update -p id=... -p body=... -p keywords=... -p type=... -p filename=... -p status=... -p extra=... -p creation_time=... -p extra2=... -p category=... -p app=... -p push_notification_text=... -p year=... -p distribution=... -p metadata=... -p download_url=... -p download_ext=... -p download_bearer=... -p download_auth=... -p skip_conversion=... -p file=... -p download_payload=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "partial_update"]
var params = {
    id: ...,
    body: ...,
    keywords: ...,
    type: ...,
    filename: ...,
    status: ...,
    extra: ...,
    creation_time: ...,
    extra2: ...,
    category: ...,
    app: ...,
    push_notification_text: ...,
    year: ...,
    distribution: ...,
    metadata: ...,
    download_url: ...,
    download_ext: ...,
    download_bearer: ...,
    download_auth: ...,
    skip_conversion: ...,
    file: ...,
    download_payload: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "partial_update"]
params = {
    "id": ...,
    "body": ...,
    "keywords": ...,
    "type": ...,
    "filename": ...,
    "status": ...,
    "extra": ...,
    "creation_time": ...,
    "extra2": ...,
    "category": ...,
    "app": ...,
    "push_notification_text": ...,
    "year": ...,
    "distribution": ...,
    "metadata": ...,
    "download_url": ...,
    "download_ext": ...,
    "download_bearer": ...,
    "download_auth": ...,
    "skip_conversion": ...,
    "file": ...,
    "download_payload": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /files/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.
`search`	A search term.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files delete -p id=... -p ordering=... -p search=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "delete"]
var params = {
    id: ...,
    ordering: ...,
    search: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "delete"]
params = {
    "id": ...,
    "ordering": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

download_url

GET /files/{id}/download-url/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`variant`	File variant to download: 'converted' (default) or 'original'.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files download_url -p id=... -p variant=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "download_url"]
var params = {
    id: ...,
    variant: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "download_url"]
params = {
    "id": ...,
    "variant": ...,
}
result = client.action(schema, action, params=params)

download

GET /files/{id}/download/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`variant`	File variant to download: 'converted' (default) or 'original'.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files download -p id=... -p variant=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "download"]
var params = {
    id: ...,
    variant: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "download"]
params = {
    "id": ...,
    "variant": ...,
}
result = client.action(schema, action, params=params)

overwrite

POST /files/{id}/overwrite/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Request Body

The request body should be a "multipart/form-data" encoded object, containing the following items.

Parameter	Description
`body` required	Name of your choice to be displayed in the interface.
`keywords`	Keywords separated by commas: `Switzerland, French`
`type`
`filename`	Name of this file in storage.
`status`
`extra`	Number of slides in a presentation or pages in a PDF.
`creation_time`	Time at which the file was created.
`extra2`	Bits separated by a vertical line enabling a presentation to be used in custom decks, `print\|mail` for PDFs and `fullscreen\|portrait` for ZIP-Archives.
`category`	Category of file. Valid values: 'json', 'pdf', 'presentation', 'video', 'zip', ''
`app` required	A unique integer value identifying this file's application.
`push_notification_text`	Text sent to devices to inform about the new file.
`year`	Set to `1` to show the first two pages of a PDF.
`distribution`	See distributions.
`metadata`	An object with key and value pairs: `{"key": "value"}`.
`download_url`	The download URL of the input file.
`download_ext`	Download file extension (including point) if not included in the download URL.
`download_bearer`	Download bearer token.
`download_auth`	Download authorization header value.
`skip_conversion`	Should set to true if created file shouldn't be converted
`file`
`download_payload`	Download url payload data value as a string.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files overwrite -p id=... -p body=... -p keywords=... -p type=... -p filename=... -p status=... -p extra=... -p creation_time=... -p extra2=... -p category=... -p app=... -p push_notification_text=... -p year=... -p distribution=... -p metadata=... -p download_url=... -p download_ext=... -p download_bearer=... -p download_auth=... -p skip_conversion=... -p file=... -p download_payload=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "overwrite"]
var params = {
    id: ...,
    body: ...,
    keywords: ...,
    type: ...,
    filename: ...,
    status: ...,
    extra: ...,
    creation_time: ...,
    extra2: ...,
    category: ...,
    app: ...,
    push_notification_text: ...,
    year: ...,
    distribution: ...,
    metadata: ...,
    download_url: ...,
    download_ext: ...,
    download_bearer: ...,
    download_auth: ...,
    skip_conversion: ...,
    file: ...,
    download_payload: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "overwrite"]
params = {
    "id": ...,
    "body": ...,
    "keywords": ...,
    "type": ...,
    "filename": ...,
    "status": ...,
    "extra": ...,
    "creation_time": ...,
    "extra2": ...,
    "category": ...,
    "app": ...,
    "push_notification_text": ...,
    "year": ...,
    "distribution": ...,
    "metadata": ...,
    "download_url": ...,
    "download_ext": ...,
    "download_bearer": ...,
    "download_auth": ...,
    "skip_conversion": ...,
    "file": ...,
    "download_payload": ...,
}
result = client.action(schema, action, params=params)

thumbnail_url

GET /files/{id}/thumbnail-url/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files thumbnail_url -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "thumbnail_url"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "thumbnail_url"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

upload_url

GET /files/{id}/upload-url/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this file.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`content_type`	A string value identifying the files content-type.

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action files upload_url -p id=... -p content_type=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["files", "upload_url"]
var params = {
    id: ...,
    content_type: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["files", "upload_url"]
params = {
    "id": ...,
    "content_type": ...,
}
result = client.action(schema, action, params=params)

me

list

GET /me/

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action me list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["me", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["me", "list"]
result = client.action(schema, action)

reports

duplication-history > list

GET /reports/duplication-history/

# Load the schema document
$ coreapi get https://api.pitcher.com/docs/

# Interact with the API endpoint
$ coreapi action reports duplication-history list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["reports", "duplication-history &gt; list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://api.pitcher.com/docs/")

# Interact with the API endpoint
action = ["reports", "duplication-history &gt; list"]
result = client.action(schema, action)

API Reference

API Reference

apps

list

Query Parameters

read

Path Parameters

Query Parameters

auth

create

Request Body

device > create

Request Body

ipaduser > create

Request Body

user > create

Request Body

categories

list

Query Parameters

create

Request Body

read

Path Parameters

Query Parameters

update

Path Parameters

Query Parameters

Request Body

partial_update

Path Parameters

Query Parameters

Request Body

delete

Path Parameters

Query Parameters

device-users

create

Request Body

read

Path Parameters

update

Path Parameters

Request Body

partial_update

Path Parameters

Request Body

delete

Path Parameters

devices

list

Query Parameters

create

Request Body

read

Path Parameters

Query Parameters

update

Path Parameters

Query Parameters

Request Body

partial_update

Path Parameters

Query Parameters

Request Body

delete

Path Parameters

Query Parameters

history > list

Query Parameters

devices-apps

list

Query Parameters

create

Request Body

update

Path Parameters

Request Body

partial_update

Path Parameters