FAIRshake

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

# Install the Python client library
$ pip install coreapi

accounts

github > create

POST /accounts/github/

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action accounts github create -p access_token=... -p code=...

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 = ["accounts", "github > create"]
var params = {
    access_token: ...,
    code: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["accounts", "github > create"]
params = {
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

globus > create

POST /accounts/globus/

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action accounts globus create -p access_token=... -p code=...

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 = ["accounts", "globus > create"]
var params = {
    access_token: ...,
    code: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["accounts", "globus > create"]
params = {
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

orcid > create

POST /accounts/orcid/

Request Body

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

Parameter	Description
`access_token`
`code`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action accounts orcid create -p access_token=... -p code=...

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 = ["accounts", "orcid > create"]
var params = {
    access_token: ...,
    code: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["accounts", "orcid > create"]
params = {
    "access_token": ...,
    "code": ...,
}
result = client.action(schema, action, params=params)

assessment

list

GET /assessment/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment list -p page=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p timestamp=...

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 = ["assessment", "list"]
var params = {
    page: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "list"]
params = {
    "page": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

create

POST /assessment/

Request Body

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

Parameter	Description
`project` required
`target` required
`rubric` required
`answers` required
`published`
`methodology`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment create -p project=... -p target=... -p rubric=... -p answers=... -p published=... -p methodology=...

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 = ["assessment", "create"]
var params = {
    project: ...,
    target: ...,
    rubric: ...,
    answers: ...,
    published: ...,
    methodology: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "create"]
params = {
    "project": ...,
    "target": ...,
    "rubric": ...,
    "answers": ...,
    "published": ...,
    "methodology": ...,
}
result = client.action(schema, action, params=params)

read

GET /assessment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment read -p id=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p timestamp=...

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 = ["assessment", "read"]
var params = {
    id: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "read"]
params = {
    "id": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

update

PUT /assessment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`timestamp`

Request Body

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

Parameter	Description
`project` required
`target` required
`rubric` required
`answers` required
`published`
`methodology`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment update -p id=... -p project=... -p target=... -p rubric=... -p answers=... -p published=... -p methodology=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p timestamp=...

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 = ["assessment", "update"]
var params = {
    id: ...,
    project: ...,
    target: ...,
    rubric: ...,
    answers: ...,
    published: ...,
    methodology: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "update"]
params = {
    "id": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "answers": ...,
    "published": ...,
    "methodology": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /assessment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`timestamp`

Request Body

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

Parameter	Description
`project`
`target`
`rubric`
`answers`
`published`
`methodology`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment partial_update -p id=... -p project=... -p target=... -p rubric=... -p answers=... -p published=... -p methodology=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p timestamp=...

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 = ["assessment", "partial_update"]
var params = {
    id: ...,
    project: ...,
    target: ...,
    rubric: ...,
    answers: ...,
    published: ...,
    methodology: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "partial_update"]
params = {
    "id": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "answers": ...,
    "published": ...,
    "methodology": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /assessment/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment delete -p id=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p timestamp=...

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 = ["assessment", "delete"]
var params = {
    id: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment", "delete"]
params = {
    "id": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

assessment_request

list

GET /assessment_request/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`assessment`
`requestor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request list -p page=... -p assessment=... -p requestor=... -p timestamp=...

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 = ["assessment_request", "list"]
var params = {
    page: ...,
    assessment: ...,
    requestor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment_request", "list"]
params = {
    "page": ...,
    "assessment": ...,
    "requestor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

create

POST /assessment_request/

Request Body

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

Parameter	Description
`assessment` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request create -p assessment=...

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 = ["assessment_request", "create"]
var params = {
    assessment: ...,
}
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://fairshake.cloud/coreapi/")

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

read

GET /assessment_request/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`assessment`
`requestor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request read -p id=... -p assessment=... -p requestor=... -p timestamp=...

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 = ["assessment_request", "read"]
var params = {
    id: ...,
    assessment: ...,
    requestor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment_request", "read"]
params = {
    "id": ...,
    "assessment": ...,
    "requestor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

update

PUT /assessment_request/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`assessment`
`requestor`
`timestamp`

Request Body

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

Parameter	Description
`assessment` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request update -p id=... -p assessment=... -p assessment=... -p requestor=... -p timestamp=...

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 = ["assessment_request", "update"]
var params = {
    id: ...,
    assessment: ...,
    assessment: ...,
    requestor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment_request", "update"]
params = {
    "id": ...,
    "assessment": ...,
    "assessment": ...,
    "requestor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /assessment_request/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`assessment`
`requestor`
`timestamp`

Request Body

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

Parameter	Description
`assessment`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request partial_update -p id=... -p assessment=... -p assessment=... -p requestor=... -p timestamp=...

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 = ["assessment_request", "partial_update"]
var params = {
    id: ...,
    assessment: ...,
    assessment: ...,
    requestor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment_request", "partial_update"]
params = {
    "id": ...,
    "assessment": ...,
    "assessment": ...,
    "requestor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /assessment_request/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`assessment`
`requestor`
`timestamp`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action assessment_request delete -p id=... -p assessment=... -p requestor=... -p timestamp=...

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 = ["assessment_request", "delete"]
var params = {
    id: ...,
    assessment: ...,
    requestor: ...,
    timestamp: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["assessment_request", "delete"]
params = {
    "id": ...,
    "assessment": ...,
    "requestor": ...,
    "timestamp": ...,
}
result = client.action(schema, action, params=params)

auth

POST /auth/login/

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: username, password Return the REST Framework Token Object's key.

Request Body

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

Parameter	Description
`username`
`email`
`password` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth login create -p username=... -p email=... -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", "login > create"]
var params = {
    username: ...,
    email: ...,
    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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "login > create"]
params = {
    "username": ...,
    "email": ...,
    "password": ...,
}
result = client.action(schema, action, params=params)

logout > list

GET /auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth logout 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 = ["auth", "logout > 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://fairshake.cloud/coreapi/")

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

logout > create

POST /auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth logout create

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", "logout > create"]
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "logout > create"]
result = client.action(schema, action)

password > change > create

POST /auth/password/change/

Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Request Body

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

Parameter	Description
`new_password1` required
`new_password2` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth password change create -p new_password1=... -p new_password2=...

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", "password > change > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "password > change > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
}
result = client.action(schema, action, params=params)

password > reset > create

POST /auth/password/reset/

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Request Body

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

Parameter	Description
`email` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

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

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", "password > reset > create"]
var params = {
    email: ...,
}
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://fairshake.cloud/coreapi/")

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

password > reset > confirm > create

POST /auth/password/reset/confirm/

Password reset e-mail link is confirmed, therefore this resets the user's password. Accepts the following POST parameters: token, uid, new_password1, new_password2 Returns the success/fail message.

Request Body

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

Parameter	Description
`new_password1` required
`new_password2` required
`uid` required
`token` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth password reset confirm create -p new_password1=... -p new_password2=... -p uid=... -p token=...

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", "password > reset > confirm > create"]
var params = {
    new_password1: ...,
    new_password2: ...,
    uid: ...,
    token: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "password > reset > confirm > create"]
params = {
    "new_password1": ...,
    "new_password2": ...,
    "uid": ...,
    "token": ...,
}
result = client.action(schema, action, params=params)

registration > create

POST /auth/registration/

Request Body

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

Parameter	Description
`username` required
`email`
`password1` required
`password2` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth registration create -p username=... -p email=... -p password1=... -p password2=...

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", "registration > create"]
var params = {
    username: ...,
    email: ...,
    password1: ...,
    password2: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "registration > create"]
params = {
    "username": ...,
    "email": ...,
    "password1": ...,
    "password2": ...,
}
result = client.action(schema, action, params=params)

registration > verify-email > create

POST /auth/registration/verify-email/

Request Body

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

Parameter	Description
`key` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth registration verify-email create -p key=...

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", "registration > verify-email > create"]
var params = {
    key: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "registration > verify-email > create"]
params = {
    "key": ...,
}
result = client.action(schema, action, params=params)

user > read

GET /auth/user/

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth user read

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 > read"]
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "user > read"]
result = client.action(schema, action)

user > update

PUT /auth/user/

Request Body

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

Parameter	Description
`username` required	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`first_name`
`last_name`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth user update -p username=... -p first_name=... -p last_name=...

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 > update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "user > update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
}
result = client.action(schema, action, params=params)

user > partial_update

PATCH /auth/user/

Request Body

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

Parameter	Description
`username`	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
`first_name`
`last_name`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth user partial_update -p username=... -p first_name=... -p last_name=...

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 > partial_update"]
var params = {
    username: ...,
    first_name: ...,
    last_name: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "user > partial_update"]
params = {
    "username": ...,
    "first_name": ...,
    "last_name": ...,
}
result = client.action(schema, action, params=params)

user > delete

DELETE /auth/user/

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action auth user delete

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 > delete"]
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["auth", "user > delete"]
result = client.action(schema, action)

digital_object

list

GET /digital_object/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`description`
`image`
`tags`
`type`
`authors`
`title`
`url`
`rubrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object list -p page=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p rubrics=... -p q=... -p url_strict=...

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 = ["digital_object", "list"]
var params = {
    page: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    rubrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "list"]
params = {
    "page": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "rubrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

create

POST /digital_object/

Request Body

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

Parameter	Description
`projects`
`description`
`image`
`tags`
`type`
`title`
`url` required
`authors`
`rubrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object create -p projects=... -p description=... -p image=... -p tags=... -p type=... -p title=... -p url=... -p authors=... -p rubrics=...

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 = ["digital_object", "create"]
var params = {
    projects: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    title: ...,
    url: ...,
    authors: ...,
    rubrics: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "create"]
params = {
    "projects": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "title": ...,
    "url": ...,
    "authors": ...,
    "rubrics": ...,
}
result = client.action(schema, action, params=params)

get_or_create

POST /digital_object/get_or_create/

Probe a digital object for the answers to various assessments

Request Body

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

Parameter	Description
`projects`
`description`
`image`
`tags`
`type`
`title`
`url` required
`authors`
`rubrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object get_or_create -p projects=... -p description=... -p image=... -p tags=... -p type=... -p title=... -p url=... -p authors=... -p rubrics=...

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 = ["digital_object", "get_or_create"]
var params = {
    projects: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    title: ...,
    url: ...,
    authors: ...,
    rubrics: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "get_or_create"]
params = {
    "projects": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "title": ...,
    "url": ...,
    "authors": ...,
    "rubrics": ...,
}
result = client.action(schema, action, params=params)

read

GET /digital_object/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`description`
`image`
`tags`
`type`
`authors`
`title`
`url`
`rubrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object read -p id=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p rubrics=... -p q=... -p url_strict=...

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 = ["digital_object", "read"]
var params = {
    id: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    rubrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "read"]
params = {
    "id": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "rubrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

update

PUT /digital_object/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`description`
`image`
`tags`
`type`
`authors`
`title`
`url`
`rubrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`projects`
`description`
`image`
`tags`
`type`
`title`
`url` required
`authors`
`rubrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object update -p id=... -p projects=... -p description=... -p image=... -p tags=... -p type=... -p title=... -p url=... -p authors=... -p rubrics=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p rubrics=... -p q=... -p url_strict=...

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 = ["digital_object", "update"]
var params = {
    id: ...,
    projects: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    title: ...,
    url: ...,
    authors: ...,
    rubrics: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    rubrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "update"]
params = {
    "id": ...,
    "projects": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "title": ...,
    "url": ...,
    "authors": ...,
    "rubrics": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "rubrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /digital_object/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`description`
`image`
`tags`
`type`
`authors`
`title`
`url`
`rubrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`projects`
`description`
`image`
`tags`
`type`
`title`
`url`
`authors`
`rubrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object partial_update -p id=... -p projects=... -p description=... -p image=... -p tags=... -p type=... -p title=... -p url=... -p authors=... -p rubrics=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p rubrics=... -p q=... -p url_strict=...

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 = ["digital_object", "partial_update"]
var params = {
    id: ...,
    projects: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    title: ...,
    url: ...,
    authors: ...,
    rubrics: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    rubrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "partial_update"]
params = {
    "id": ...,
    "projects": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "title": ...,
    "url": ...,
    "authors": ...,
    "rubrics": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "rubrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /digital_object/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`description`
`image`
`tags`
`type`
`authors`
`title`
`url`
`rubrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object delete -p id=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p rubrics=... -p q=... -p url_strict=...

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 = ["digital_object", "delete"]
var params = {
    id: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    rubrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["digital_object", "delete"]
params = {
    "id": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "rubrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

probe

GET /digital_object/{id}/probe/

Probe a digital object for the answers to various assessments

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action digital_object probe -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 = ["digital_object", "probe"]
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://fairshake.cloud/coreapi/")

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

metric

list

GET /metric/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`title`
`url`
`description`
`image`
`tags`
`authors`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric list -p page=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p authors=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p q=... -p url_strict=...

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 = ["metric", "list"]
var params = {
    page: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    authors: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "list"]
params = {
    "page": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "authors": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

create

POST /metric/

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p authors=...

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 = ["metric", "create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    authors: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "authors": ...,
}
result = client.action(schema, action, params=params)

get_or_create

POST /metric/get_or_create/

Probe a digital object for the answers to various assessments

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric get_or_create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p authors=...

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 = ["metric", "get_or_create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    authors: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "get_or_create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "authors": ...,
}
result = client.action(schema, action, params=params)

read

GET /metric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`authors`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric read -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p authors=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p q=... -p url_strict=...

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 = ["metric", "read"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    authors: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "read"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "authors": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

update

PUT /metric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`authors`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p authors=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p authors=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p q=... -p url_strict=...

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 = ["metric", "update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    authors: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    authors: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "authors": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /metric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`authors`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric partial_update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p authors=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p authors=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p q=... -p url_strict=...

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 = ["metric", "partial_update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    authors: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    authors: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "authors": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /metric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`authors`
`type`
`license`
`rationale`
`principle`
`fairmetrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action metric delete -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p authors=... -p type=... -p license=... -p rationale=... -p principle=... -p fairmetrics=... -p q=... -p url_strict=...

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 = ["metric", "delete"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    authors: ...,
    type: ...,
    license: ...,
    rationale: ...,
    principle: ...,
    fairmetrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["metric", "delete"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "authors": ...,
    "type": ...,
    "license": ...,
    "rationale": ...,
    "principle": ...,
    "fairmetrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

project

list

GET /project/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`digital_objects`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project list -p page=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p digital_objects=... -p q=... -p url_strict=...

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 = ["project", "list"]
var params = {
    page: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    digital_objects: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "list"]
params = {
    "page": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "digital_objects": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

create

POST /project/

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=...

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 = ["project", "create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
}
result = client.action(schema, action, params=params)

get_or_create

POST /project/get_or_create/

Probe a digital object for the answers to various assessments

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project get_or_create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=...

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 = ["project", "get_or_create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "get_or_create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
}
result = client.action(schema, action, params=params)

read

GET /project/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`digital_objects`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project read -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p digital_objects=... -p q=... -p url_strict=...

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 = ["project", "read"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    digital_objects: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "read"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "digital_objects": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

update

PUT /project/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`digital_objects`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p digital_objects=... -p q=... -p url_strict=...

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 = ["project", "update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    digital_objects: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "digital_objects": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /project/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`digital_objects`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project partial_update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p digital_objects=... -p q=... -p url_strict=...

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 = ["project", "partial_update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    digital_objects: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "digital_objects": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /project/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`digital_objects`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action project delete -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p digital_objects=... -p q=... -p url_strict=...

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 = ["project", "delete"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    digital_objects: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["project", "delete"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "digital_objects": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

rubric

list

GET /rubric/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`license`
`metrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric list -p page=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p license=... -p metrics=... -p q=... -p url_strict=...

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 = ["rubric", "list"]
var params = {
    page: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    license: ...,
    metrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "list"]
params = {
    "page": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "license": ...,
    "metrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

create

POST /rubric/

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`authors`
`metrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p authors=... -p metrics=...

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 = ["rubric", "create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    authors: ...,
    metrics: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "authors": ...,
    "metrics": ...,
}
result = client.action(schema, action, params=params)

get_or_create

POST /rubric/get_or_create/

Probe a digital object for the answers to various assessments

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`authors`
`metrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric get_or_create -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p authors=... -p metrics=...

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 = ["rubric", "get_or_create"]
var params = {
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    authors: ...,
    metrics: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "get_or_create"]
params = {
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "authors": ...,
    "metrics": ...,
}
result = client.action(schema, action, params=params)

read

GET /rubric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`license`
`metrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric read -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p license=... -p metrics=... -p q=... -p url_strict=...

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 = ["rubric", "read"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    license: ...,
    metrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "read"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "license": ...,
    "metrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

update

PUT /rubric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`license`
`metrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title` required
`url`
`description`
`image`
`tags`
`type`
`license`
`authors`
`metrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p authors=... -p metrics=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p license=... -p metrics=... -p q=... -p url_strict=...

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 = ["rubric", "update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    authors: ...,
    metrics: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    license: ...,
    metrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "authors": ...,
    "metrics": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "license": ...,
    "metrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /rubric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`license`
`metrics`
`q`
`url_strict`

Request Body

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`license`
`authors`
`metrics`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric partial_update -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p license=... -p authors=... -p metrics=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p license=... -p metrics=... -p q=... -p url_strict=...

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 = ["rubric", "partial_update"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    license: ...,
    authors: ...,
    metrics: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    license: ...,
    metrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "partial_update"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "license": ...,
    "authors": ...,
    "metrics": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "license": ...,
    "metrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /rubric/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`title`
`url`
`description`
`image`
`tags`
`type`
`authors`
`license`
`metrics`
`q`
`url_strict`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action rubric delete -p id=... -p title=... -p url=... -p description=... -p image=... -p tags=... -p type=... -p authors=... -p license=... -p metrics=... -p q=... -p url_strict=...

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 = ["rubric", "delete"]
var params = {
    id: ...,
    title: ...,
    url: ...,
    description: ...,
    image: ...,
    tags: ...,
    type: ...,
    authors: ...,
    license: ...,
    metrics: ...,
    q: ...,
    url_strict: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["rubric", "delete"]
params = {
    "id": ...,
    "title": ...,
    "url": ...,
    "description": ...,
    "image": ...,
    "tags": ...,
    "type": ...,
    "authors": ...,
    "license": ...,
    "metrics": ...,
    "q": ...,
    "url_strict": ...,
}
result = client.action(schema, action, params=params)

score

list

GET /score/

Generate aggregate scores on a per-rubric and per-metric basis.

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`id`
`digital_object`
`url`
`url_strict`
`metric`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action score list -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p id=... -p digital_object=... -p url=... -p url_strict=... -p metric=...

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 = ["score", "list"]
var params = {
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    id: ...,
    digital_object: ...,
    url: ...,
    url_strict: ...,
    metric: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["score", "list"]
params = {
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "id": ...,
    "digital_object": ...,
    "url": ...,
    "url_strict": ...,
    "metric": ...,
}
result = client.action(schema, action, params=params)

read

GET /score/{id}/

Request an score for a digital resource

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

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

Parameter	Description
`published`
`project`
`target`
`rubric`
`methodology`
`assessor`
`id`
`digital_object`
`url`
`url_strict`
`metric`

# Load the schema document
$ coreapi get https://fairshake.cloud/coreapi/

# Interact with the API endpoint
$ coreapi action score read -p id=... -p published=... -p project=... -p target=... -p rubric=... -p methodology=... -p assessor=... -p id=... -p digital_object=... -p url=... -p url_strict=... -p metric=...

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 = ["score", "read"]
var params = {
    id: ...,
    published: ...,
    project: ...,
    target: ...,
    rubric: ...,
    methodology: ...,
    assessor: ...,
    id: ...,
    digital_object: ...,
    url: ...,
    url_strict: ...,
    metric: ...,
}
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://fairshake.cloud/coreapi/")

# Interact with the API endpoint
action = ["score", "read"]
params = {
    "id": ...,
    "published": ...,
    "project": ...,
    "target": ...,
    "rubric": ...,
    "methodology": ...,
    "assessor": ...,
    "id": ...,
    "digital_object": ...,
    "url": ...,
    "url_strict": ...,
    "metric": ...,
}
result = client.action(schema, action, params=params)