Skip to main content

Create an ActivitySpec.

Create an ActivitySpec.

Request Body — REQUIRED
id string — REQUIRED

The name of the activity spec.

help_contents string

Either a binary blob containing a document or video, or a string containing instructional aid about the Activity.

script_contents string

The WebView-compatible script that provides this Activity on mobile or desktop (IFrame) clients.

static_data_schema object

The static data definition of an ActivitySpec.

$id uri-reference
$schema uri
$ref uri-reference
$comment string
title string
description string
readOnly boolean
examples undefined[]
multipleOf number
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
minLength integer
pattern regex
additionalItems (circular)
items (circular)
maxItems integer
minItems integer
uniqueItems boolean
contains (circular)
maxProperties integer
minProperties integer
required string[]
additionalProperties (circular)
definitions object
properties object
patternProperties object
dependencies object
propertyNames (circular)
enum undefined[]
type
format string
contentMediaType string
contentEncoding string
if (circular)
then (circular)
else (circular)
anyOf (circular)[]
oneOf (circular)[]
not (circular)
temporal_event_schema object

The temporal event data definition of an ActivitySpec.

$id uri-reference
$schema uri
$ref uri-reference
$comment string
title string
description string
readOnly boolean
examples undefined[]
multipleOf number
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
minLength integer
pattern regex
additionalItems (circular)
items (circular)
maxItems integer
minItems integer
uniqueItems boolean
contains (circular)
maxProperties integer
minProperties integer
required string[]
additionalProperties (circular)
definitions object
properties object
patternProperties object
dependencies object
propertyNames (circular)
enum undefined[]
type
format string
contentMediaType string
contentEncoding string
if (circular)
then (circular)
else (circular)
anyOf (circular)[]
oneOf (circular)[]
not (circular)
settings_schema object

The Activity settings definition of an ActivitySpec.

$id uri-reference
$schema uri
$ref uri-reference
$comment string
title string
description string
readOnly boolean
examples undefined[]
multipleOf number
maximum number
exclusiveMaximum number
minimum number
exclusiveMinimum number
maxLength integer
minLength integer
pattern regex
additionalItems (circular)
items (circular)
maxItems integer
minItems integer
uniqueItems boolean
contains (circular)
maxProperties integer
minProperties integer
required string[]
additionalProperties (circular)
definitions object
properties object
patternProperties object
dependencies object
propertyNames (circular)
enum undefined[]
type
format string
contentMediaType string
contentEncoding string
if (circular)
then (circular)
else (circular)
anyOf (circular)[]
oneOf (circular)[]
not (circular)
Responses
200

Success

Schema — OPTIONAL
data object — OPTIONAL
default

Error

Schema — OPTIONAL
error string — OPTIONAL