docs.jsonld
type: ApiDocumentation
title: CitSci API
description: These are the API endpoints for the CitSci Platform. [CitSci.org](https://citsci.org) and our [Mobile Apps](https://citsci.org/apps) consume this API.
entrypoint: /
supported class: Error
supported class: Area
supported class: Datasheet
supported class: DatasheetRecord
supported class: DatasheetRecordResults
supported class: DatasheetZooniverseHistory
supported class: FieldAppearanceOption
supported class: FieldValidator
supported class: FileObject
supported class: Notification
supported class: NotificationPreference
supported class: Observation
supported class: ObservationObserver
supported class: ObservationRecord
supported class: ObservationResource
supported class: OptionValue
supported class: OptionsSet
supported class: Organism
supported class: Organization
supported class: OrganizationMember
supported class: OrganizationProject
supported class: OrganizationResource
supported class: Project
supported class: ProjectAirtableHistory
supported class: ProjectDownload
supported class: ProjectLike
supported class: ProjectMember
supported class: ProjectMemberInvite
supported class: ProjectMemberLocation
supported class: ProjectPost
supported class: ProjectResource
supported class: ProjectSciStarterHistory
supported class: ProjectSubresourceTags
supported class: RecordOrganism
supported class: Scorecard
supported class: ScorecardBin
supported class: Stat
supported class: Topics
supported class: User
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:title
  title: hydra:title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hydra:description
  title: hydra:description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error

title
type: Property
domain: Error
range: string

detail
type: Property
domain: Error
range: string

status
type: Property
domain: Error
range: integer

instance
type: Property
domain: Error
range: string

type
type: Property
domain: Error
range: string

trace
type: Property
domain: Error

message
type: Property
domain: Error
range: string

code
type: Property
domain: Error
range: integer

file
type: Property
domain: Error
range: string

line
type: Property
domain: Error
range: integer

hydra:title
type: Property
domain: Error
range: string

hydra:description
type: Property
domain: Error
range: string

description
type: Property
domain: Error
range: string

string
type: Property
domain: Error

previous
type: Property
domain: Error

traceAsString
type: Property
domain: Error
range: string

Area
type: Class
title: Area
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
  description: The name of the location.
supported property: SupportedProperty
  property: lngLat
  title: lngLat
  required: false
  readable: true
  writeable: true
  description: The longitude and latitude of the location in WGS 84 format. For example: POINT(30.123 50.456). Future implementation: In the case of polygons, this represents the centroid of the polygon. In the case of lines, this represents the endpoint of the line.
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project this location belongs to.
supported property: SupportedProperty
  property: observationsTotal
  title: observationsTotal
  required: false
  readable: true
  writeable: false
  description: The total number of observations for this location.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Area resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Area resource.
  returns: Area
supported operation: Deletes the Area resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Area resource.
  returns: Nothing
supported operation: Replaces the Area resource.
  type: Operation
  type: ReplaceAction
  expects: Area
  method: PUT
  title: Replaces the Area resource.
  returns: Area
description: An area/location

name
type: Property
domain: Area
range: string

lngLat
type: Property
domain: Area

project
type: Property
domain: Area
max cardinality: 1
range: Project

observationsTotal
type: Property
domain: Area
range: integer

createdAt
type: Property
domain: Area
range: dateTime

updatedAt
type: Property
domain: Area
range: dateTime

Datasheet
type: Class
title: Datasheet
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
  description: The datasheet name.
supported property: SupportedProperty
  property: instructions
  title: instructions
  required: false
  readable: true
  writeable: true
  description: The datasheet instructions.
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project the datasheet belongs to.
supported property: SupportedProperty
  property: projection
  title: projection
  required: false
  readable: true
  writeable: true
  description: The projection type of the datasheet.
supported property: SupportedProperty
  property: locationFormat
  title: locationFormat
  required: false
  readable: true
  writeable: true
  description: The location format type (0=Coordinates; 1=Picklist; 2=Both)
supported property: SupportedProperty
  property: locationAutoAssign
  title: locationAutoAssign
  required: false
  readable: true
  writeable: true
  description: The location auto assign type (1=User; 2=Datasheet)
supported property: SupportedProperty
  property: dateFormat
  title: dateFormat
  required: false
  readable: true
  writeable: true
  description: The date format allowed for the current datasheet.
supported property: SupportedProperty
  property: records
  title: records
  required: false
  readable: true
  writeable: true
  description: The records of the datasheet.
supported property: SupportedProperty
  property: zooniverseHistory
  title: zooniverseHistory
  required: false
  readable: true
  writeable: true
  description: The history of zooniverse image transfers for this datasheet
supported property: SupportedProperty
  property: published
  title: published
  required: false
  readable: true
  writeable: true
  description: Whether the datasheet is published or draft.
supported property: SupportedProperty
  property: isPrivate
  title: isPrivate
  required: false
  readable: true
  writeable: true
  description: Whether the datasheet is public or private
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: The status of the datasheet. The status can be: - draft: at least one single record is not ready (DatasheetRecord::isReady property is false) or the datasheet name is empty; - published: all the records are ready (DatasheetRecord::isReady property is true) and the name is not empty.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Datasheet resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Datasheet resource.
  returns: Datasheet
supported operation: Deletes the Datasheet resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Datasheet resource.
  returns: Nothing
supported operation: Replaces the Datasheet resource.
  type: Operation
  type: ReplaceAction
  expects: Datasheet
  method: PUT
  title: Replaces the Datasheet resource.
  returns: Datasheet
supported operation: Updates the Datasheet resource.
  type: Operation
  expects: Datasheet
  method: PATCH
  title: Updates the Datasheet resource.
  returns: Datasheet
description: A datasheet

name
type: Property
domain: Datasheet
range: string

instructions
type: Property
domain: Datasheet
range: string

project
type: Property
domain: Datasheet
max cardinality: 1
range: Project

projection
type: Property
domain: Datasheet
range: string

locationFormat
type: Property
domain: Datasheet
range: integer

locationAutoAssign
type: Property
domain: Datasheet
range: integer

dateFormat
type: Property
domain: Datasheet
range: string

records
type: Property
domain: Datasheet
range: DatasheetRecord

zooniverseHistory
type: Property
domain: Datasheet
range: DatasheetZooniverseHistory

published
type: Property
domain: Datasheet
range: boolean

isPrivate
type: Property
domain: Datasheet
range: boolean

status
type: Property
domain: Datasheet
range: string

createdAt
type: Property
domain: Datasheet
range: dateTime

updatedAt
type: Property
domain: Datasheet
range: dateTime

DatasheetRecord
type: Class
title: DatasheetRecord
supported property: SupportedProperty
  property: parentRecord
  title: parentRecord
  required: false
  readable: true
  writeable: true
  description: The section under which the current record was added.
supported property: SupportedProperty
  property: orderNumber
  title: orderNumber
  required: false
  readable: true
  writeable: true
  description: The record position in the datasheet.
supported property: SupportedProperty
  property: isPrivate
  title: isPrivate
  required: false
  readable: true
  writeable: true
  description: Is this datasheet record private?
supported property: SupportedProperty
  property: recordType
  title: recordType
  required: false
  readable: true
  writeable: true
  description: The record type
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
  description: The label/measurement that represents the current record Can be empty if the record represents an organism (picklist or not) or is related to a measurement/attribute.
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: The description/hint of the record.
supported property: SupportedProperty
  property: isReady
  title: isReady
  required: false
  readable: true
  writeable: false
  description: Indicates if the current record is valid to be published.
supported property: SupportedProperty
  property: allowAnyOrganism
  title: allowAnyOrganism
  required: false
  readable: true
  writeable: true
  description: Indicates if the current entry is an "Any Organism" record.
supported property: SupportedProperty
  property: organisms
  title: organisms
  required: false
  readable: true
  writeable: true
  description: The organisms associated with this record.
supported property: SupportedProperty
  property: allowReplica
  title: allowReplica
  required: false
  readable: true
  writeable: true
  description: Whether the current record can be replicated.
supported property: SupportedProperty
  property: defaultValue
  title: defaultValue
  required: false
  readable: true
  writeable: true
  description: The default value of the datasheet record (not used for dropdown/radio or set data types)
supported property: SupportedProperty
  property: optionsSet
  title: optionsSet
  required: false
  readable: true
  writeable: true
  description: The option set of the datasheet record. It applies for fields like dropdown, radio/multiple choice lists, toggle buttons.
supported property: SupportedProperty
  property: validators
  title: validators
  required: false
  readable: true
  writeable: true
  description: The validators of this datasheet record.
supported property: SupportedProperty
  property: appearanceOptions
  title: appearanceOptions
  required: false
  readable: true
  writeable: true
  description: The appearance options of this datasheet record.
supported property: SupportedProperty
  property: records
  title: records
  required: false
  readable: true
  writeable: true
  description: The child records of the current record.
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: false
  writeable: true
  description: Indicates if the datasheet record is active or not.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a DatasheetRecord resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DatasheetRecord resource.
  returns: DatasheetRecord
supported operation: Updates the DatasheetRecord resource.
  type: Operation
  expects: DatasheetRecord
  method: PATCH
  title: Updates the DatasheetRecord resource.
  returns: DatasheetRecord
supported operation: Retrieves a DatasheetRecord resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DatasheetRecord resource.
  returns: DatasheetRecord
description: A datasheet record

parentRecord
type: Property
domain: DatasheetRecord
max cardinality: 1
range: DatasheetRecord

orderNumber
type: Property
domain: DatasheetRecord
range: integer

isPrivate
type: Property
domain: DatasheetRecord
range: boolean

recordType
type: Property
domain: DatasheetRecord
range: string

label
type: Property
domain: DatasheetRecord
range: string

description
type: Property
domain: DatasheetRecord
range: string

isReady
type: Property
domain: DatasheetRecord
range: boolean

allowAnyOrganism
type: Property
domain: DatasheetRecord
range: boolean

organisms
type: Property
domain: DatasheetRecord
range: RecordOrganism

allowReplica
type: Property
domain: DatasheetRecord
range: boolean

defaultValue
type: Property
domain: DatasheetRecord
range: string

optionsSet
type: Property
domain: DatasheetRecord
max cardinality: 1
range: OptionsSet

validators
type: Property
domain: DatasheetRecord
range: FieldValidator

appearanceOptions
type: Property
domain: DatasheetRecord
range: FieldAppearanceOption

records
type: Property
domain: DatasheetRecord
range: DatasheetRecord

isActive
type: Property
domain: DatasheetRecord
range: boolean

createdAt
type: Property
domain: DatasheetRecord
range: dateTime

updatedAt
type: Property
domain: DatasheetRecord
range: dateTime

DatasheetRecordResults
type: Class
title: DatasheetRecordResults
supported property: SupportedProperty
  property: noObservations
  title: noObservations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: numerical
  title: numerical
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: categorical
  title: categorical
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organism
  title: organism
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a DatasheetRecordResults resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DatasheetRecordResults resource.
  returns: DatasheetRecordResults

noObservations
type: Property
domain: DatasheetRecordResults
range: string

numerical
type: Property
domain: DatasheetRecordResults

categorical
type: Property
domain: DatasheetRecordResults

organism
type: Property
domain: DatasheetRecordResults

DatasheetZooniverseHistory
type: Class
title: DatasheetZooniverseHistory
supported property: SupportedProperty
  property: datasheet
  title: datasheet
  required: false
  readable: true
  writeable: true
  description: The datasheet this history entry belongs to
supported property: SupportedProperty
  property: imageCount
  title: imageCount
  required: false
  readable: true
  writeable: false
  description: The number of photos transmitted.
supported property: SupportedProperty
  property: datasheetName
  title: datasheetName
  required: false
  readable: true
  writeable: false
  description: The datasheet name.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a DatasheetZooniverseHistory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DatasheetZooniverseHistory resource.
  returns: Nothing
description: Zooniverse transfer history for a datasheet

datasheet
type: Property
domain: DatasheetZooniverseHistory
max cardinality: 1
range: Datasheet

imageCount
type: Property
domain: DatasheetZooniverseHistory
range: integer

datasheetName
type: Property
domain: DatasheetZooniverseHistory
range: string

createdAt
type: Property
domain: DatasheetZooniverseHistory
range: dateTime

updatedAt
type: Property
domain: DatasheetZooniverseHistory
range: dateTime

FieldAppearanceOption
type: Class
title: FieldAppearanceOption
supported property: SupportedProperty
  property: datasheetRecord
  title: datasheetRecord
  required: false
  readable: false
  writeable: true
  description: The datasheet record the appearance option was created for
supported property: SupportedProperty
  property: optionType
  title: optionType
  required: false
  readable: true
  writeable: true
  description: The appearance option type
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FieldAppearanceOption resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FieldAppearanceOption resource.
  returns: Nothing
description: A datasheet field appearance option.

datasheetRecord
type: Property
domain: FieldAppearanceOption
max cardinality: 1
range: DatasheetRecord

optionType
type: Property
domain: FieldAppearanceOption
range: string

createdAt
type: Property
domain: FieldAppearanceOption
range: dateTime

updatedAt
type: Property
domain: FieldAppearanceOption
range: dateTime

FieldValidator
type: Class
title: FieldValidator
supported property: SupportedProperty
  property: datasheetRecord
  title: datasheetRecord
  required: false
  readable: false
  writeable: true
  description: The field the validator was created for.
supported property: SupportedProperty
  property: validatorType
  title: validatorType
  required: false
  readable: true
  writeable: true
  description: The validator type
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
  description: The validator value
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
  description: The extra options of this validator
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FieldValidator resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FieldValidator resource.
  returns: Nothing
description: A datasheet field validator.

datasheetRecord
type: Property
domain: FieldValidator
max cardinality: 1
range: DatasheetRecord

validatorType
type: Property
domain: FieldValidator
range: string

value
type: Property
domain: FieldValidator
range: string

options
type: Property
domain: FieldValidator

createdAt
type: Property
domain: FieldValidator
range: dateTime

updatedAt
type: Property
domain: FieldValidator
range: dateTime

FileObject
type: Class
title: FileObject
supported property: SupportedProperty
  property: file
  title: file
  required: true
  readable: false
  writeable: true
  description: An uploaded file.
supported property: SupportedProperty
  property: filename
  title: filename
  required: false
  readable: true
  writeable: false
  description: The name of the file.
supported property: SupportedProperty
  property: path
  title: path
  required: false
  readable: true
  writeable: false
  description: The path of the file.
supported property: SupportedProperty
  property: mimeType
  title: mimeType
  required: false
  readable: true
  writeable: false
  description: The type of the file.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
  description: The user that uploaded the file.
supported property: SupportedProperty
  property: actionType
  title: actionType
  required: true
  readable: false
  writeable: true
  description: The action type.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FileObject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FileObject resource.
  returns: FileObject
supported operation: Deletes the FileObject resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FileObject resource.
  returns: Nothing
description: A file object.

file
type: Property
domain: FileObject

filename
type: Property
domain: FileObject
range: string

path
type: Property
domain: FileObject
range: string

mimeType
type: Property
domain: FileObject
range: string

user
type: Property
domain: FileObject
max cardinality: 1
range: User

actionType
type: Property
domain: FileObject
range: string

createdAt
type: Property
domain: FileObject
range: dateTime

updatedAt
type: Property
domain: FileObject
range: dateTime

Notification
type: Class
title: Notification
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectUrl
  title: projectUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: typeIdentifier
  title: typeIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRead
  title: isRead
  required: false
  readable: true
  writeable: true
  description: Indicates if the notification has been read or not
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Notification resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Notification resource.
  returns: Notification
supported operation: Updates the Notification resource.
  type: Operation
  expects: Notification
  method: PATCH
  title: Updates the Notification resource.
  returns: Notification

user
type: Property
domain: Notification
max cardinality: 1
range: User

projectUrl
type: Property
domain: Notification
range: string

typeIdentifier
type: Property
domain: Notification
range: string

isRead
type: Property
domain: Notification
range: boolean

type
type: Property
domain: Notification
range: string

title
type: Property
domain: Notification
range: string

createdAt
type: Property
domain: Notification
range: dateTime

updatedAt
type: Property
domain: Notification
range: dateTime

NotificationPreference
type: Class
title: NotificationPreference
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: projectMember
  title: projectMember
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notificationType
  title: notificationType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailNotify
  title: emailNotify
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: webNotify
  title: webNotify
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a NotificationPreference resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a NotificationPreference resource.
  returns: NotificationPreference
supported operation: Updates the NotificationPreference resource.
  type: Operation
  expects: NotificationPreference
  method: PATCH
  title: Updates the NotificationPreference resource.
  returns: NotificationPreference

user
type: Property
domain: NotificationPreference
max cardinality: 1
range: User

projectMember
type: Property
domain: NotificationPreference
max cardinality: 1
range: ProjectMember

notificationType
type: Property
domain: NotificationPreference
range: string

emailNotify
type: Property
domain: NotificationPreference
range: boolean

webNotify
type: Property
domain: NotificationPreference
range: boolean

createdAt
type: Property
domain: NotificationPreference
range: dateTime

updatedAt
type: Property
domain: NotificationPreference
range: dateTime

Observation
type: Class
title: Observation
supported property: SupportedProperty
  property: datasheet
  title: datasheet
  required: false
  readable: true
  writeable: true
  description: The datasheet used to create this observation.
supported property: SupportedProperty
  property: observedAt
  title: observedAt
  required: false
  readable: true
  writeable: true
  description: The date the observation was recorded.
supported property: SupportedProperty
  property: observers
  title: observers
  required: false
  readable: true
  writeable: true
  description: The observers that recorded this observation.
supported property: SupportedProperty
  property: location
  title: location
  required: false
  readable: true
  writeable: true
  description: The location assigned to observation.
supported property: SupportedProperty
  property: lngLat
  title: lngLat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: records
  title: records
  required: false
  readable: true
  writeable: true
  description: The records of the observation.
supported property: SupportedProperty
  property: files
  title: files
  required: false
  readable: true
  writeable: true
  description: The observation resources
supported operation: Retrieves a Observation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Observation resource.
  returns: Observation
supported operation: Deletes the Observation resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Observation resource.
  returns: Nothing
supported operation: Replaces the Observation resource.
  type: Operation
  type: ReplaceAction
  expects: Observation
  method: PUT
  title: Replaces the Observation resource.
  returns: Observation
supported operation: Updates the Observation resource.
  type: Operation
  expects: Observation
  method: PATCH
  title: Updates the Observation resource.
  returns: Observation
description: An observation

datasheet
type: Link
domain: Observation
max cardinality: 1
range: Datasheet

observedAt
type: Property
domain: Observation
range: dateTime

observers
type: Link
domain: Observation
range: ObservationObserver

location
type: Link
domain: Observation
max cardinality: 1
range: Area

lngLat
type: Property
domain: Observation

records
type: Link
domain: Observation
range: ObservationRecord

files
type: Link
domain: Observation
range: ObservationResource

ObservationObserver
type: Class
title: ObservationObserver
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: false
  writeable: true
  description: The observer that registered the observation.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ObservationObserver resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ObservationObserver resource.
  returns: ObservationObserver
description: A relation between observation and user.

user
type: Property
domain: ObservationObserver
max cardinality: 1
range: User

createdAt
type: Property
domain: ObservationObserver
range: dateTime

updatedAt
type: Property
domain: ObservationObserver
range: dateTime

ObservationRecord
type: Class
title: ObservationRecord
supported property: SupportedProperty
  property: datasheetRecord
  title: datasheetRecord
  required: false
  readable: false
  writeable: true
  description: The datasheet record from which the current one was created.
supported property: SupportedProperty
  property: observation
  title: observation
  required: false
  readable: false
  writeable: true
  description: The observation the record was created for.
supported property: SupportedProperty
  property: parentRecord
  title: parentRecord
  required: false
  readable: true
  writeable: true
  description: The section under which the current record was added.
supported property: SupportedProperty
  property: orderNumber
  title: orderNumber
  required: false
  readable: true
  writeable: true
  description: The record position in the observation.
supported property: SupportedProperty
  property: isPrivate
  title: isPrivate
  required: false
  readable: true
  writeable: false
  description: Whether the observation record is public or private
supported property: SupportedProperty
  property: recordType
  title: recordType
  required: false
  readable: true
  writeable: true
  description: The record type
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
  description: The label/measurement that represents the current record Can be empty if the record represents an organism (picklist or not) or is related to a measurement/attribute.
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: The description/hint of the record.
supported property: SupportedProperty
  property: organism
  title: organism
  required: false
  readable: true
  writeable: true
  description: The organism associated with this record (if the record represents an organism).
supported property: SupportedProperty
  property: records
  title: records
  required: false
  readable: true
  writeable: true
  description: The children records of the current record
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
  description: The value of the record.
supported property: SupportedProperty
  property: files
  title: files
  required: false
  readable: true
  writeable: true
  description: The files associated with this observation record
supported property: SupportedProperty
  property: optionValue
  title: optionValue
  required: false
  readable: true
  writeable: true
  description: The value of the options set value selected for this record. This will be null for the records that have no options set.
supported property: SupportedProperty
  property: multiSelectOptionValues
  title: multiSelectOptionValues
  required: false
  readable: true
  writeable: true
  description: The option values selected for multiselect This will be null for the records that are not multi select
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ObservationRecord resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ObservationRecord resource.
  returns: ObservationRecord
supported operation: Deletes the ObservationRecord resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ObservationRecord resource.
  returns: Nothing
supported operation: Updates the ObservationRecord resource.
  type: Operation
  expects: ObservationRecord
  method: PATCH
  title: Updates the ObservationRecord resource.
  returns: ObservationRecord
description: An observation record.

datasheetRecord
type: Property
domain: ObservationRecord
max cardinality: 1
range: DatasheetRecord

observation
type: Property
domain: ObservationRecord
max cardinality: 1
range: Observation

parentRecord
type: Property
domain: ObservationRecord
max cardinality: 1
range: ObservationRecord

orderNumber
type: Property
domain: ObservationRecord
range: integer

isPrivate
type: Property
domain: ObservationRecord
range: boolean

recordType
type: Property
domain: ObservationRecord
range: string

label
type: Property
domain: ObservationRecord
range: string

description
type: Property
domain: ObservationRecord
range: string

organism
type: Property
domain: ObservationRecord
max cardinality: 1
range: RecordOrganism

records
type: Property
domain: ObservationRecord
range: ObservationRecord

value
type: Property
domain: ObservationRecord
range: string

files
type: Property
domain: ObservationRecord
range: FileObject

optionValue
type: Property
domain: ObservationRecord
max cardinality: 1
range: OptionValue

multiSelectOptionValues
type: Property
domain: ObservationRecord
range: OptionValue

createdAt
type: Property
domain: ObservationRecord
range: dateTime

updatedAt
type: Property
domain: ObservationRecord
range: dateTime

ObservationResource
type: Class
title: ObservationResource
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
  description: The file resource.
supported property: SupportedProperty
  property: observation
  title: observation
  required: false
  readable: false
  writeable: true
  description: The observation this file was added to.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ObservationResource resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ObservationResource resource.
  returns: ObservationResource
description: An observation resource

file
type: Property
domain: ObservationResource
max cardinality: 1
range: FileObject

observation
type: Property
domain: ObservationResource
max cardinality: 1
range: Observation

createdAt
type: Property
domain: ObservationResource
range: dateTime

updatedAt
type: Property
domain: ObservationResource
range: dateTime

OptionValue
type: Class
title: OptionValue
supported property: SupportedProperty
  property: value
  title: value
  required: false
  readable: true
  writeable: true
  description: The value of this option.
supported property: SupportedProperty
  property: dataType
  title: dataType
  required: false
  readable: true
  writeable: true
  description: The type of the option field.
supported property: SupportedProperty
  property: orderNumber
  title: orderNumber
  required: false
  readable: true
  writeable: true
  description: The position of the choice in the data set.
supported property: SupportedProperty
  property: isDefault
  title: isDefault
  required: false
  readable: true
  writeable: true
  description: Indicates if the value is the default one or not. The data set can have no default value.
supported property: SupportedProperty
  property: isCustomValue
  title: isCustomValue
  required: false
  readable: true
  writeable: true
  description: Indicates if the current option must define a custom value for the dataset.
supported property: SupportedProperty
  property: optionsSet
  title: optionsSet
  required: false
  readable: false
  writeable: true
  description: The options set this option value belongs to.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a OptionValue resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OptionValue resource.
  returns: Nothing
description: Values in an Option Set

value
type: Property
domain: OptionValue
range: string

dataType
type: Property
domain: OptionValue
range: string

orderNumber
type: Property
domain: OptionValue
range: integer

isDefault
type: Property
domain: OptionValue
range: boolean

isCustomValue
type: Property
domain: OptionValue
range: boolean

optionsSet
type: Property
domain: OptionValue
max cardinality: 1
range: OptionsSet

createdAt
type: Property
domain: OptionValue
range: dateTime

updatedAt
type: Property
domain: OptionValue
range: dateTime

OptionsSet
type: Class
title: OptionsSet
supported property: SupportedProperty
  property: allowOther
  title: allowOther
  required: false
  readable: true
  writeable: true
  description: Indicates if the options set allows a custom value.
supported property: SupportedProperty
  property: datasheetRecord
  title: datasheetRecord
  required: false
  readable: false
  writeable: true
  description: The datasheet record associated with this data set.
supported property: SupportedProperty
  property: optionsValues
  title: optionsValues
  required: false
  readable: true
  writeable: true
  description: The option values of the data set.
supported property: SupportedProperty
  property: defaultOptionValue
  title: defaultOptionValue
  required: false
  readable: true
  writeable: false
  description: The default option value of the set.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a OptionsSet resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OptionsSet resource.
  returns: Nothing
description: A set of values of a datasheet field.

allowOther
type: Property
domain: OptionsSet
range: boolean

datasheetRecord
type: Property
domain: OptionsSet
max cardinality: 1
range: DatasheetRecord

optionsValues
type: Property
domain: OptionsSet
range: OptionValue

defaultOptionValue
type: Property
domain: OptionsSet
max cardinality: 1
range: OptionValue

createdAt
type: Property
domain: OptionsSet
range: dateTime

updatedAt
type: Property
domain: OptionsSet
range: dateTime

Organism
type: Class
title: Organism
supported property: SupportedProperty
  property: rank
  title: rank
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: scientificName
  title: scientificName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: canonicalName
  title: canonicalName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Organism resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Organism resource.
  returns: Organism
description: An organism (GBIF Backbone Taxonomy) Partial pagination prevents long query times of counting all 5 million organisms, also istart is a little faster than ipartial

rank
type: Property
domain: Organism
range: string

scientificName
type: Property
domain: Organism
range: string

canonicalName
type: Property
domain: Organism
range: string

Organization
type: Class
title: Organization
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
  description: The id of this organization.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
  description: The name of the organization.
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: The organization description.
supported property: SupportedProperty
  property: shortDescription
  title: shortDescription
  required: false
  readable: true
  writeable: true
  description: The organization short description.
supported property: SupportedProperty
  property: organizationProjects
  title: organizationProjects
  required: false
  readable: true
  writeable: true
  description: The projects belonging to this organization
supported property: SupportedProperty
  property: projects
  title: projects
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: approveAffiliation
  title: approveAffiliation
  required: false
  readable: true
  writeable: true
  description: Do project affiliations require approval?
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
  description: The Organization's Logo
supported property: SupportedProperty
  property: banner
  title: banner
  required: false
  readable: true
  writeable: true
  description: The Organization's banner image
supported property: SupportedProperty
  property: latitude
  title: latitude
  required: false
  readable: true
  writeable: true
  description: Organization coordinates: latitude.
supported property: SupportedProperty
  property: longitude
  title: longitude
  required: false
  readable: true
  writeable: true
  description: Organization coordinates: longitude.
supported property: SupportedProperty
  property: website
  title: website
  required: false
  readable: true
  writeable: true
  description: The external website field.
supported property: SupportedProperty
  property: facebookLink
  title: facebookLink
  required: false
  readable: true
  writeable: true
  description: The Organization's facebook URL
supported property: SupportedProperty
  property: twitterLink
  title: twitterLink
  required: false
  readable: true
  writeable: true
  description: The Organization's twitter URL
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Organization resource.
  returns: Organization
supported operation: Replaces the Organization resource.
  type: Operation
  type: ReplaceAction
  expects: Organization
  method: PUT
  title: Replaces the Organization resource.
  returns: Organization
supported operation: Retrieves a Organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Organization resource.
  returns: Organization
description: An Organization.

id
type: Property
domain: Organization

name
type: Property
domain: Organization
range: string

description
type: Property
domain: Organization
range: string

shortDescription
type: Property
domain: Organization
range: string

organizationProjects
type: Property
domain: Organization
range: OrganizationProject

projects
type: Property
domain: Organization

approveAffiliation
type: Property
domain: Organization
range: boolean

logo
type: Property
domain: Organization
max cardinality: 1
range: FileObject

banner
type: Property
domain: Organization
max cardinality: 1
range: FileObject

latitude
type: Property
domain: Organization
range: decimal

longitude
type: Property
domain: Organization
range: decimal

website
type: Property
domain: Organization
range: string

facebookLink
type: Property
domain: Organization
range: string

twitterLink
type: Property
domain: Organization
range: string

createdAt
type: Property
domain: Organization
range: dateTime

updatedAt
type: Property
domain: Organization
range: dateTime

OrganizationMember
type: Class
title: OrganizationMember
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: false
  writeable: true
  description: The User added to the organization.
supported property: SupportedProperty
  property: role
  title: role
  required: false
  readable: true
  writeable: true
  description: The member role. Accepted roles: "manager" "member" The user can have one single role per organization at any time.
supported property: SupportedProperty
  property: approved
  title: approved
  required: false
  readable: true
  writeable: true
  description: Whether the member role was approved or not.
supported property: SupportedProperty
  property: approvedAt
  title: approvedAt
  required: false
  readable: true
  writeable: true
  description: The date when the member role was approved.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationUrl
  title: organizationUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organizationName
  title: organizationName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: displayName
  title: displayName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a OrganizationMember resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrganizationMember resource.
  returns: OrganizationMember
description: An organization member

user
type: Property
domain: OrganizationMember
max cardinality: 1
range: User

role
type: Property
domain: OrganizationMember
range: string

approved
type: Property
domain: OrganizationMember
range: boolean

approvedAt
type: Property
domain: OrganizationMember
range: dateTime

createdAt
type: Property
domain: OrganizationMember
range: dateTime

updatedAt
type: Property
domain: OrganizationMember
range: dateTime

organizationId
type: Property
domain: OrganizationMember

organizationUrl
type: Property
domain: OrganizationMember
range: string

organizationName
type: Property
domain: OrganizationMember
range: string

userId
type: Property
domain: OrganizationMember

displayName
type: Property
domain: OrganizationMember
range: string

OrganizationProject
type: Class
title: OrganizationProject
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
  description: The organization
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project
supported property: SupportedProperty
  property: requester
  title: requester
  required: false
  readable: true
  writeable: true
  description: The requesting user
supported property: SupportedProperty
  property: approved
  title: approved
  required: false
  readable: true
  writeable: true
  description: Is the request approved
supported property: SupportedProperty
  property: approvedAt
  title: approvedAt
  required: false
  readable: true
  writeable: false
  description: The date when the request was approved
supported property: SupportedProperty
  property: approver
  title: approver
  required: false
  readable: true
  writeable: true
  description: The approving user
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a OrganizationProject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrganizationProject resource.
  returns: OrganizationProject
supported operation: Updates the OrganizationProject resource.
  type: Operation
  expects: OrganizationProject
  method: PATCH
  title: Updates the OrganizationProject resource.
  returns: OrganizationProject
description: An Organization Project

organization
type: Property
domain: OrganizationProject
max cardinality: 1
range: Organization

project
type: Property
domain: OrganizationProject
max cardinality: 1
range: Project

requester
type: Property
domain: OrganizationProject
max cardinality: 1
range: User

approved
type: Property
domain: OrganizationProject
range: boolean

approvedAt
type: Property
domain: OrganizationProject
range: dateTime

approver
type: Property
domain: OrganizationProject
max cardinality: 1
range: User

createdAt
type: Property
domain: OrganizationProject
range: dateTime

updatedAt
type: Property
domain: OrganizationProject
range: dateTime

OrganizationResource
type: Class
title: OrganizationResource
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: false
  writeable: true
  description: The organization this resource was added to.
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
  description: The resource name.
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true
  description: The resource URL (for links).
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
  description: The file resource.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a OrganizationResource resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a OrganizationResource resource.
  returns: OrganizationResource
supported operation: Replaces the OrganizationResource resource.
  type: Operation
  type: ReplaceAction
  expects: OrganizationResource
  method: PUT
  title: Replaces the OrganizationResource resource.
  returns: OrganizationResource
supported operation: Deletes the OrganizationResource resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the OrganizationResource resource.
  returns: Nothing
description: An organization resource (file or link)

organization
type: Property
domain: OrganizationResource
max cardinality: 1
range: Organization

name
type: Property
domain: OrganizationResource
range: string

url
type: Property
domain: OrganizationResource
range: string

file
type: Property
domain: OrganizationResource
max cardinality: 1
range: FileObject

createdAt
type: Property
domain: OrganizationResource
range: dateTime

updatedAt
type: Property
domain: OrganizationResource
range: dateTime

type
type: Property
domain: OrganizationResource
range: string

Project
type: Class
title: Project
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
  description: The project name.
supported property: SupportedProperty
  property: urlField
  title: urlField
  required: false
  readable: true
  writeable: true
  description: The project urlField.
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: The project description.
supported property: SupportedProperty
  property: website
  title: website
  required: false
  readable: true
  writeable: true
  description: The external website field.
supported property: SupportedProperty
  property: gettingStarted
  title: gettingStarted
  required: false
  readable: true
  writeable: true
  description: The getting started field.
supported property: SupportedProperty
  property: facebookLink
  title: facebookLink
  required: false
  readable: true
  writeable: true
  description: The facebook field
supported property: SupportedProperty
  property: twitterLink
  title: twitterLink
  required: false
  readable: true
  writeable: true
  description: The twitter/X field
supported property: SupportedProperty
  property: instagramLink
  title: instagramLink
  required: false
  readable: true
  writeable: true
  description: The instagram field
supported property: SupportedProperty
  property: goals
  title: goals
  required: false
  readable: true
  writeable: true
  description: The project goals.
supported property: SupportedProperty
  property: tasks
  title: tasks
  required: false
  readable: true
  writeable: true
  description: The project tasks.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
  description: The owner of this project.
supported property: SupportedProperty
  property: latitude
  title: latitude
  required: false
  readable: true
  writeable: true
  description: Project coordinates: latitude.
supported property: SupportedProperty
  property: longitude
  title: longitude
  required: false
  readable: true
  writeable: true
  description: Project coordinates: longitude.
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: false
  writeable: false
  description: Indicates if the project is active or not.
supported property: SupportedProperty
  property: isPrivate
  title: isPrivate
  required: false
  readable: true
  writeable: true
  description: Indicates if the project is private or public.
supported property: SupportedProperty
  property: approveContacts
  title: approveContacts
  required: false
  readable: true
  writeable: true
  description: Indicates if the project has open or closed membership.
supported property: SupportedProperty
  property: projectState
  title: projectState
  required: false
  readable: true
  writeable: true
  description: The project status <draft|published|etc...>
supported property: SupportedProperty
  property: isZooniverse
  title: isZooniverse
  required: false
  readable: true
  writeable: true
  description: Indicates if the project should be published on project
supported property: SupportedProperty
  property: isSciStarter
  title: isSciStarter
  required: false
  readable: true
  writeable: true
  description: Indicates if the project should be published on SciStarter
supported property: SupportedProperty
  property: sciStarterID
  title: sciStarterID
  required: false
  readable: true
  writeable: true
  description: Indicates the corresponding published SciStarter project id.
supported property: SupportedProperty
  property: sciStarterUrl
  title: sciStarterUrl
  required: false
  readable: true
  writeable: false
  description: The SciStarter URL slug returned in the API reply.
supported property: SupportedProperty
  property: isAirtable
  title: isAirtable
  required: false
  readable: true
  writeable: true
  description: Whether the manager has shared their Airtable Auth with this project
supported property: SupportedProperty
  property: zooniverseID
  title: zooniverseID
  required: false
  readable: true
  writeable: true
  description: The project ID on Zooniverse.
supported property: SupportedProperty
  property: zooniverseUserName
  title: zooniverseUserName
  required: false
  readable: true
  writeable: false
  description: the Zooniverse username
supported property: SupportedProperty
  property: zooniverseUserDisplayName
  title: zooniverseUserDisplayName
  required: false
  readable: true
  writeable: false
  description: the Zooniverse manager's display name
supported property: SupportedProperty
  property: picture
  title: picture
  required: false
  readable: true
  writeable: true
  description: The project profile image.
supported property: SupportedProperty
  property: bannerPicture
  title: bannerPicture
  required: false
  readable: true
  writeable: true
  description: The banner image of the project.
supported property: SupportedProperty
  property: datasheets
  title: datasheets
  required: false
  readable: true
  writeable: false
  description: The datasheets created for this project.
supported property: SupportedProperty
  property: totalLikes
  title: totalLikes
  required: false
  readable: true
  writeable: false
  description: The project members.
supported operation: Retrieves a Project resource.
supported operation: Replaces the Project resource.
supported operation: Updates the Project resource.
description: A project

name
type: Property
domain: Project
range: string

urlField
type: Property
domain: Project
range: string

description
type: Property
domain: Project
range: string

website
type: Property
domain: Project
range: string

gettingStarted
type: Property
domain: Project
range: string

facebookLink
type: Property
domain: Project
range: string

twitterLink
type: Property
domain: Project
range: string

instagramLink
type: Property
domain: Project
range: string

goals
type: Property
domain: Project
range: string

tasks
type: Property
domain: Project
range: string

user
type: Property
domain: Project
max cardinality: 1
range: User

latitude
type: Property
domain: Project
range: decimal

longitude
type: Property
domain: Project
range: decimal

isActive
type: Property
domain: Project
range: boolean

isPrivate
type: Property
domain: Project
range: boolean

approveContacts
type: Property
domain: Project
range: boolean

projectState
type: Property
domain: Project
range: integer

isZooniverse
type: Property
domain: Project
range: boolean

isSciStarter
type: Property
domain: Project
range: boolean

sciStarterID
type: Property
domain: Project
range: integer

sciStarterUrl
type: Property
domain: Project
range: string

isAirtable
type: Property
domain: Project
range: boolean

zooniverseID
type: Property
domain: Project
range: integer

zooniverseUserName
type: Property
domain: Project
range: string

zooniverseUserDisplayName
type: Property
domain: Project
range: string

picture
type: Property
domain: Project
max cardinality: 1
range: FileObject

bannerPicture
type: Property
domain: Project
max cardinality: 1
range: FileObject

datasheets
type: Property
domain: Project
range: Datasheet

totalLikes
type: Property
domain: Project
range: ProjectLike

measurementsTotal
type: Property
domain: Project
range: integer

organizationProjects
type: Property
domain: Project
range: OrganizationProject

organizations
type: Property
domain: Project

announcement
type: Property
domain: Project
range: string

announcementDate
type: Property
domain: Project
range: dateTime

topics
type: Property
domain: Project

lastObservationDatetime
type: Property
domain: Project
range: dateTime

createdAt
type: Property
domain: Project
range: dateTime

updatedAt
type: Property
domain: Project
range: dateTime

ProjectAirtableHistory
type: Class
title: ProjectAirtableHistory
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project this history entry belongs to
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
  description: The User this history entry belongs to
supported property: SupportedProperty
  property: airtableBaseId
  title: airtableBaseId
  required: false
  readable: false
  writeable: true
  description: The Base where data is sent to at Airtable
supported property: SupportedProperty
  property: airtableTableId
  title: airtableTableId
  required: false
  readable: false
  writeable: true
  description: The existing table where data is sent to at Airtable
supported property: SupportedProperty
  property: airtableTableName
  title: airtableTableName
  required: false
  readable: false
  writeable: true
  description: The new table name where data is to be sent at Airtable
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: The status of the job Accepted statuses: "submitted" "in progress" "completed" "failed"
supported property: SupportedProperty
  property: startedAt
  title: startedAt
  required: false
  readable: true
  writeable: false
  description: The time the DB processing started
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
  description: The time in seconds it took the job to complete/fail from a DB processing standpoint.
supported property: SupportedProperty
  property: failureReason
  title: failureReason
  required: false
  readable: true
  writeable: false
  description: The reason for failure
supported property: SupportedProperty
  property: observationCount
  title: observationCount
  required: false
  readable: true
  writeable: false
  description: The number of observations sent.
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectAirtableHistory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectAirtableHistory resource.
  returns: ProjectAirtableHistory
description: An Airtable History entry

project
type: Property
domain: ProjectAirtableHistory
max cardinality: 1
range: Project

user
type: Property
domain: ProjectAirtableHistory
max cardinality: 1
range: User

airtableBaseId
type: Property
domain: ProjectAirtableHistory
range: string

airtableTableId
type: Property
domain: ProjectAirtableHistory
range: string

airtableTableName
type: Property
domain: ProjectAirtableHistory
range: string

status
type: Property
domain: ProjectAirtableHistory
range: string

startedAt
type: Property
domain: ProjectAirtableHistory
range: dateTime

duration
type: Property
domain: ProjectAirtableHistory
range: integer

failureReason
type: Property
domain: ProjectAirtableHistory
range: string

observationCount
type: Property
domain: ProjectAirtableHistory
range: integer

createdAt
type: Property
domain: ProjectAirtableHistory
range: dateTime

updatedAt
type: Property
domain: ProjectAirtableHistory
range: dateTime

ProjectDownload
type: Class
title: ProjectDownload
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project the job was requested for.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
  description: The User who requested the job.
supported property: SupportedProperty
  property: downloadOutputType
  title: downloadOutputType
  required: false
  readable: true
  writeable: false
  description: The type of the download job Accepted types: "flat" "hierarchical"
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: The status of the download job Accepted status: "submitted" "in progress" "completed" "failed"
supported property: SupportedProperty
  property: startedAt
  title: startedAt
  required: false
  readable: true
  writeable: false
  description: The time the DB processing started
supported property: SupportedProperty
  property: path
  title: path
  required: false
  readable: true
  writeable: false
  description: The path of the download file.
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
  description: The time in seconds it took the job to complete/fail from a DB processing standpoint.
supported property: SupportedProperty
  property: numRecords
  title: numRecords
  required: false
  readable: true
  writeable: false
  description: The no. of records in the data download
supported property: SupportedProperty
  property: failureReason
  title: failureReason
  required: false
  readable: true
  writeable: false
  description: The reason for failure
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectDownload resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectDownload resource.
  returns: ProjectDownload
description: A Project Download Request

project
type: Property
domain: ProjectDownload
max cardinality: 1
range: Project

user
type: Property
domain: ProjectDownload
max cardinality: 1
range: User

downloadOutputType
type: Property
domain: ProjectDownload
range: string

status
type: Property
domain: ProjectDownload
range: string

startedAt
type: Property
domain: ProjectDownload
range: dateTime

path
type: Property
domain: ProjectDownload
range: string

duration
type: Property
domain: ProjectDownload
range: integer

numRecords
type: Property
domain: ProjectDownload
range: integer

failureReason
type: Property
domain: ProjectDownload
range: string

createdAt
type: Property
domain: ProjectDownload
range: dateTime

updatedAt
type: Property
domain: ProjectDownload
range: dateTime

ProjectLike
type: Class
title: ProjectLike
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: false
  writeable: true
  description: The project the member was added to.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: false
  writeable: true
  description: The user that liked the project.
supported property: SupportedProperty
  property: isLiked
  title: isLiked
  required: false
  readable: true
  writeable: false
  description: Indicates if a project is liked by a user or not
supported property: SupportedProperty
  property: projectId
  title: projectId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectLike resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectLike resource.
  returns: ProjectLike
supported operation: Deletes the ProjectLike resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectLike resource.
  returns: Nothing
description: A project.

project
type: Link
domain: ProjectLike
max cardinality: 1
range: Project

user
type: Link
domain: ProjectLike
max cardinality: 1
range: User

isLiked
type: Property
domain: ProjectLike
range: boolean

projectId
type: Property
domain: ProjectLike

userId
type: Property
domain: ProjectLike

ProjectMember
type: Class
title: ProjectMember
supported property: SupportedProperty
  property: member
  title: member
  required: false
  readable: false
  writeable: true
  description: The member added to the project.
supported property: SupportedProperty
  property: role
  title: role
  required: false
  readable: true
  writeable: true
  description: The member role. Accepted roles: "manager" "member" The user can have one single role per project at the time.
supported property: SupportedProperty
  property: approved
  title: approved
  required: false
  readable: true
  writeable: true
  description: Whether the member role was approved or not. The owner of the project will be automatically approved as manager. TODO: the members that are not approved in a specific time frame (e.g. 72 hours) should be automatically removed.
supported property: SupportedProperty
  property: isInvite
  title: isInvite
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: approvedAt
  title: approvedAt
  required: false
  readable: true
  writeable: true
  description: The date when the member role was approved. The owner of the project will be automatically approved as manager.
supported property: SupportedProperty
  property: isZooniverseCollaborator
  title: isZooniverseCollaborator
  required: false
  readable: false
  writeable: true
  description: Whether the member is a zooniverse collaborator The member has to be a manager
supported property: SupportedProperty
  property: notificationPreferences
  title: notificationPreferences
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectId
  title: projectId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectName
  title: projectName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectState
  title: projectState
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectUrl
  title: projectUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: projectApproveContact
  title: projectApproveContact
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: displayName
  title: displayName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: zooniverseUsername
  title: zooniverseUsername
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectMember resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectMember resource.
  returns: ProjectMember
supported operation: Updates the ProjectMember resource.
  type: Operation
  expects: ProjectMember
  method: PATCH
  title: Updates the ProjectMember resource.
  returns: ProjectMember
supported operation: Updates the ProjectMember resource.
  type: Operation
  expects: ProjectMember
  method: PATCH
  title: Updates the ProjectMember resource.
  returns: ProjectMember
supported operation: Deletes the ProjectMember resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectMember resource.
  returns: Nothing
description: A project member

member
type: Property
domain: ProjectMember
max cardinality: 1
range: User

role
type: Property
domain: ProjectMember
range: string

approved
type: Property
domain: ProjectMember
range: boolean

isInvite
type: Property
domain: ProjectMember
range: boolean

approvedAt
type: Property
domain: ProjectMember
range: dateTime

isZooniverseCollaborator
type: Property
domain: ProjectMember
range: boolean

notificationPreferences
type: Property
domain: ProjectMember
range: NotificationPreference

createdAt
type: Property
domain: ProjectMember
range: dateTime

updatedAt
type: Property
domain: ProjectMember
range: dateTime

projectId
type: Property
domain: ProjectMember

projectName
type: Property
domain: ProjectMember
range: string

projectState
type: Property
domain: ProjectMember
range: integer

projectUrl
type: Property
domain: ProjectMember
range: string

projectApproveContact
type: Property
domain: ProjectMember
range: boolean

userId
type: Property
domain: ProjectMember

displayName
type: Property
domain: ProjectMember
range: string

zooniverseUsername
type: Property
domain: ProjectMember
range: string

ProjectMemberInvite
type: Class
title: ProjectMemberInvite
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project the user was invited to.
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
  description: The email of the user.
supported property: SupportedProperty
  property: inviteMessage
  title: inviteMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isExpired
  title: isExpired
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectMemberInvite resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectMemberInvite resource.
  returns: ProjectMemberInvite
supported operation: Deletes the ProjectMemberInvite resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectMemberInvite resource.
  returns: Nothing
description: A project member invitation // TODO: Automatically remove the expired member invites from DB.

project
type: Property
domain: ProjectMemberInvite
max cardinality: 1
range: Project

firstName
type: Property
domain: ProjectMemberInvite
range: string

lastName
type: Property
domain: ProjectMemberInvite
range: string

email
type: Property
domain: ProjectMemberInvite
range: string

inviteMessage
type: Property
domain: ProjectMemberInvite
range: string

createdAt
type: Property
domain: ProjectMemberInvite
range: dateTime

updatedAt
type: Property
domain: ProjectMemberInvite
range: dateTime

isExpired
type: Property
domain: ProjectMemberInvite
range: boolean

ProjectMemberLocation
type: Class
title: ProjectMemberLocation
supported property: SupportedProperty
  property: member
  title: member
  required: false
  readable: true
  writeable: true
  description: The project member
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project
supported property: SupportedProperty
  property: datasheet
  title: datasheet
  required: false
  readable: true
  writeable: true
  description: The datasheet
supported property: SupportedProperty
  property: location
  title: location
  required: false
  readable: true
  writeable: true
  description: The location assigned
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectMemberLocation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectMemberLocation resource.
  returns: ProjectMemberLocation
supported operation: Deletes the ProjectMemberLocation resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectMemberLocation resource.
  returns: Nothing
description: A project member's assigned location

member
type: Property
domain: ProjectMemberLocation
max cardinality: 1
range: ProjectMember

project
type: Property
domain: ProjectMemberLocation
max cardinality: 1
range: Project

datasheet
type: Property
domain: ProjectMemberLocation
max cardinality: 1
range: Datasheet

location
type: Property
domain: ProjectMemberLocation
max cardinality: 1
range: Area

createdAt
type: Property
domain: ProjectMemberLocation
range: dateTime

updatedAt
type: Property
domain: ProjectMemberLocation
range: dateTime

ProjectPost
type: Class
title: ProjectPost
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project where the post was made
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
  description: The user that made the project post
supported property: SupportedProperty
  property: parentPost
  title: parentPost
  required: false
  readable: true
  writeable: true
  description: The parent project post
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
  description: The subject field for project post
supported property: SupportedProperty
  property: discussionText
  title: discussionText
  required: false
  readable: true
  writeable: true
  description: The description field of the project post
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
  description: The tags associated with this forum post stored as a json object
supported property: SupportedProperty
  property: isHidden
  title: isHidden
  required: false
  readable: true
  writeable: true
  description: Indicates if the forum post is hidden
supported property: SupportedProperty
  property: isEmailMembers
  title: isEmailMembers
  required: false
  readable: false
  writeable: true
  description: Indicates if the members are going to be notified of this forum post.
supported property: SupportedProperty
  property: repliedPosts
  title: repliedPosts
  required: false
  readable: true
  writeable: true
  description: The children posts of this project post
supported property: SupportedProperty
  property: files
  title: files
  required: false
  readable: true
  writeable: true
  description: The files associated with this project post
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectPost resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectPost resource.
  returns: ProjectPost
supported operation: Deletes the ProjectPost resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectPost resource.
  returns: Nothing
supported operation: Replaces the ProjectPost resource.
  type: Operation
  type: ReplaceAction
  expects: ProjectPost
  method: PUT
  title: Replaces the ProjectPost resource.
  returns: ProjectPost
description: A project Post

project
type: Property
domain: ProjectPost
max cardinality: 1
range: Project

user
type: Property
domain: ProjectPost
max cardinality: 1
range: User

parentPost
type: Property
domain: ProjectPost
max cardinality: 1
range: ProjectPost

subject
type: Property
domain: ProjectPost
range: string

discussionText
type: Property
domain: ProjectPost
range: string

tags
type: Property
domain: ProjectPost

isHidden
type: Property
domain: ProjectPost
range: boolean

isEmailMembers
type: Property
domain: ProjectPost
range: boolean

repliedPosts
type: Property
domain: ProjectPost
range: ProjectPost

files
type: Property
domain: ProjectPost
range: FileObject

createdAt
type: Property
domain: ProjectPost
range: dateTime

updatedAt
type: Property
domain: ProjectPost
range: dateTime

ProjectResource
type: Class
title: ProjectResource
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
  description: The resource name.
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true
  description: The resource URL (for links).
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
  description: The file resource.
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: false
  writeable: true
  description: The project this resource was added to.
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
  description: The resource type.
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
  description: The tags associated with this project resource stored as a json object
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectResource resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectResource resource.
  returns: ProjectResource
supported operation: Deletes the ProjectResource resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProjectResource resource.
  returns: Nothing
supported operation: Replaces the ProjectResource resource.
  type: Operation
  type: ReplaceAction
  expects: ProjectResource
  method: PUT
  title: Replaces the ProjectResource resource.
  returns: ProjectResource
description: A project resource (file, link or map layer)

name
type: Property
domain: ProjectResource
range: string

url
type: Property
domain: ProjectResource
range: string

file
type: Property
domain: ProjectResource
max cardinality: 1
range: FileObject

project
type: Property
domain: ProjectResource
max cardinality: 1
range: Project

type
type: Property
domain: ProjectResource
range: string

tags
type: Property
domain: ProjectResource

createdAt
type: Property
domain: ProjectResource
range: dateTime

updatedAt
type: Property
domain: ProjectResource
range: dateTime

ProjectSciStarterHistory
type: Class
title: ProjectSciStarterHistory
supported property: SupportedProperty
  property: project
  title: project
  required: false
  readable: true
  writeable: true
  description: The project the history was requested for.
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
  description: The User this history entry belongs to
supported property: SupportedProperty
  property: syncType
  title: syncType
  required: false
  readable: true
  writeable: false
  description: The type of the synchronization Accepted types:
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
  description: The status of the history Accepted status: "submitted" "in progress" "completed" "failed"
supported property: SupportedProperty
  property: startedAt
  title: startedAt
  required: false
  readable: true
  writeable: false
  description: The time the synchronization started
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: false
  description: The time in seconds it took the sync to complete/fail.
supported property: SupportedProperty
  property: failureReason
  title: failureReason
  required: false
  readable: true
  writeable: false
  description: The reason for failure
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ProjectSciStarterHistory resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectSciStarterHistory resource.
  returns: Nothing
description: A SciStarter History GET Request

project
type: Property
domain: ProjectSciStarterHistory
max cardinality: 1
range: Project

user
type: Property
domain: ProjectSciStarterHistory
max cardinality: 1
range: User

syncType
type: Property
domain: ProjectSciStarterHistory
range: string

status
type: Property
domain: ProjectSciStarterHistory
range: string

startedAt
type: Property
domain: ProjectSciStarterHistory
range: dateTime

duration
type: Property
domain: ProjectSciStarterHistory
range: integer

failureReason
type: Property
domain: ProjectSciStarterHistory
range: string

createdAt
type: Property
domain: ProjectSciStarterHistory
range: dateTime

updatedAt
type: Property
domain: ProjectSciStarterHistory
range: dateTime

ProjectSubresourceTags
type: Class
title: ProjectSubresourceTags
supported property: SupportedProperty
  property: all
  title: all
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: popular
  title: popular
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a ProjectSubresourceTags resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ProjectSubresourceTags resource.
  returns: ProjectSubresourceTags

all
type: Property
domain: ProjectSubresourceTags

popular
type: Property
domain: ProjectSubresourceTags

RecordOrganism
type: Class
title: RecordOrganism
supported property: SupportedProperty
  property: organism
  title: organism
  required: false
  readable: false
  writeable: true
  description: The organism associated with the record.
supported property: SupportedProperty
  property: customName
  title: customName
  required: false
  readable: true
  writeable: true
  description: The custom name given to this organism.
supported property: SupportedProperty
  property: organismId
  title: organismId
  required: false
  readable: true
  writeable: false
  description: The organism id.
supported property: SupportedProperty
  property: rank
  title: rank
  required: false
  readable: true
  writeable: false
  description: The rank of the organism.
supported property: SupportedProperty
  property: scientificName
  title: scientificName
  required: false
  readable: true
  writeable: false
  description: The scientific name of the organism. TODO: the GBIF DB was explained later. The rigth scientific name for CitSci is the DB canonical name.
supported property: SupportedProperty
  property: canonicalName
  title: canonicalName
  required: false
  readable: true
  writeable: false
  description: The canonical name of the organism. TODO: this variable was used in a wrong way in the past, the GBIF DB was explained later. This is used as the common name.
supported operation: Retrieves a RecordOrganism resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a RecordOrganism resource.
  returns: RecordOrganism
description: A relation between organism and datasheet/observation record

organism
type: Property
domain: RecordOrganism
max cardinality: 1
range: Organism

customName
type: Property
domain: RecordOrganism
range: string

organismId
type: Property
domain: RecordOrganism
range: integer

rank
type: Property
domain: RecordOrganism
range: string

scientificName
type: Property
domain: RecordOrganism
range: string

canonicalName
type: Property
domain: RecordOrganism
range: string

Scorecard
type: Class
title: Scorecard
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
  description: The title of the scorecard.
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
  description: The scorecard description.
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: true
  description: The organization this scorecard belongs to
supported property: SupportedProperty
  property: datasheetRecord
  title: datasheetRecord
  required: false
  readable: true
  writeable: true
  description: The datasheet record this scorecard is tied to
supported property: SupportedProperty
  property: dataType
  title: dataType
  required: false
  readable: true
  writeable: false
  description: The type of the scorecard (numerical | categorical)
supported property: SupportedProperty
  property: bins
  title: bins
  required: false
  readable: true
  writeable: true
  description: The bins associated with this scorecard
supported property: SupportedProperty
  property: info
  title: info
  required: false
  readable: true
  writeable: true
  description: Brief information about this scorecard
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: true
  description: The resource tied to this scorecard
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Scorecard resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Scorecard resource.
  returns: Scorecard
supported operation: Replaces the Scorecard resource.
  type: Operation
  type: ReplaceAction
  expects: Scorecard
  method: PUT
  title: Replaces the Scorecard resource.
  returns: Scorecard
supported operation: Deletes the Scorecard resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Scorecard resource.
  returns: Nothing
description: A Scorecard

title
type: Property
domain: Scorecard
range: string

description
type: Property
domain: Scorecard
range: string

organization
type: Property
domain: Scorecard
max cardinality: 1
range: Organization

datasheetRecord
type: Property
domain: Scorecard
max cardinality: 1
range: DatasheetRecord

dataType
type: Property
domain: Scorecard
range: string

bins
type: Property
domain: Scorecard
range: ScorecardBin

info
type: Property
domain: Scorecard
range: string

resource
type: Property
domain: Scorecard
max cardinality: 1
range: OrganizationResource

createdAt
type: Property
domain: Scorecard
range: dateTime

updatedAt
type: Property
domain: Scorecard
range: dateTime

ScorecardBin
type: Class
title: ScorecardBin
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
  description: The label of this bin
supported property: SupportedProperty
  property: orderNumber
  title: orderNumber
  required: false
  readable: true
  writeable: true
  description: The order number of this bin
supported property: SupportedProperty
  property: maxValue
  title: maxValue
  required: false
  readable: true
  writeable: true
  description: The maximum numeric value for this bin
supported property: SupportedProperty
  property: minValue
  title: minValue
  required: false
  readable: true
  writeable: true
  description: The minimum numeric value for this bin
supported property: SupportedProperty
  property: optionValues
  title: optionValues
  required: false
  readable: true
  writeable: true
  description: The option values assigned to this bin
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ScorecardBin resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ScorecardBin resource.
  returns: ScorecardBin
description: A scorecard bin

label
type: Property
domain: ScorecardBin
range: string

orderNumber
type: Property
domain: ScorecardBin
range: integer

maxValue
type: Property
domain: ScorecardBin
range: decimal

minValue
type: Property
domain: ScorecardBin
range: decimal

optionValues
type: Property
domain: ScorecardBin
range: OptionValue

createdAt
type: Property
domain: ScorecardBin
range: dateTime

updatedAt
type: Property
domain: ScorecardBin
range: dateTime

Stat
type: Class
title: Stat
supported property: SupportedProperty
  property: usersTotal
  title: usersTotal
  required: false
  readable: true
  writeable: false
  description: The total of users.
supported property: SupportedProperty
  property: projectsTotal
  title: projectsTotal
  required: false
  readable: true
  writeable: false
  description: The total of projects.
supported property: SupportedProperty
  property: locationsTotal
  title: locationsTotal
  required: false
  readable: true
  writeable: false
  description: The total of locations.
supported property: SupportedProperty
  property: observationsTotal
  title: observationsTotal
  required: false
  readable: true
  writeable: false
  description: The total of observations.
supported property: SupportedProperty
  property: protocolsTotal
  title: protocolsTotal
  required: false
  readable: true
  writeable: false
  description: The total of protocols.
supported property: SupportedProperty
  property: measurementsTotal
  title: measurementsTotal
  required: false
  readable: true
  writeable: false
  description: The total of measurements (observation records).
supported property: SupportedProperty
  property: likesTotal
  title: likesTotal
  required: false
  readable: true
  writeable: false
  description: The total of likes done by the user.
supported property: SupportedProperty
  property: postsTotal
  title: postsTotal
  required: false
  readable: true
  writeable: false
  description: The total of posts done by the user.
supported operation: Retrieves a Stat resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Stat resource.
  returns: Stat
description: Stats POPO

usersTotal
type: Property
domain: Stat
range: integer

projectsTotal
type: Property
domain: Stat
range: integer

locationsTotal
type: Property
domain: Stat
range: integer

observationsTotal
type: Property
domain: Stat
range: integer

protocolsTotal
type: Property
domain: Stat
range: integer

measurementsTotal
type: Property
domain: Stat
range: integer

likesTotal
type: Property
domain: Stat
range: integer

postsTotal
type: Property
domain: Stat
range: integer

Topics
type: Class
title: Topics
supported property: SupportedProperty
  property: all
  title: all
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: popular
  title: popular
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Topics resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Topics resource.
  returns: Nothing

all
type: Property
domain: Topics

popular
type: Property
domain: Topics

User
type: Class
title: User
supported property: SupportedProperty
  property: username
  title: username
  required: false
  readable: true
  writeable: true
  description: The username of the user
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: false
  writeable: true
  description: The plain password, not stored
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
  description: The email of the user
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: false
  readable: false
  writeable: false
  description: Indicates if the user is active or not
supported property: SupportedProperty
  property: isVerified
  title: isVerified
  required: false
  readable: true
  writeable: false
  description: Indicates if the user email was verified
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
  description: User first name
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
  description: User last name
supported property: SupportedProperty
  property: displayName
  title: displayName
  required: false
  readable: true
  writeable: false
  description: User display name based on their privacy setting
supported property: SupportedProperty
  property: privacySetting
  title: privacySetting
  required: false
  readable: true
  writeable: false
  description: User Privacy Setting
supported property: SupportedProperty
  property: picture
  title: picture
  required: false
  readable: true
  writeable: false
  description: The profile image
supported property: SupportedProperty
  property: projects
  title: projects
  required: false
  readable: true
  writeable: false
  description: The projects this user created.
supported property: SupportedProperty
  property: memberships
  title: memberships
  required: false
  readable: true
  writeable: false
  description: The projects this user created or is a part of.
supported property: SupportedProperty
  property: organizationMemberships
  title: organizationMemberships
  required: false
  readable: true
  writeable: false
  description: The organizations this user is a manager of
supported property: SupportedProperty
  property: userLikes
  title: userLikes
  required: false
  readable: true
  writeable: false
  description: the totalLikes of the user.
supported property: SupportedProperty
  property: receivesNewsletter
  title: receivesNewsletter
  required: false
  readable: true
  writeable: true
  description: If the user wants to receive the newsletter.
supported property: SupportedProperty
  property: zooniverseUsername
  title: zooniverseUsername
  required: false
  readable: true
  writeable: false
  description: The username of the user on Zooniverse.
supported property: SupportedProperty
  property: sciStarterId
  title: sciStarterId
  required: false
  readable: true
  writeable: false
  description: The SciStarter OAuth ID of the user
supported property: SupportedProperty
  property: isAirtable
  title: isAirtable
  required: false
  readable: true
  writeable: false
  description: Returns if user has even authorized with Airtable
supported property: SupportedProperty
  property: isAirtableExpired
  title: isAirtableExpired
  required: false
  readable: true
  writeable: false
  description: Returns if the Airtable Refresh token has expired
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: changeEmailPending
  title: changeEmailPending
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User
description: A user

username
type: Property
domain: User
range: string

password
type: Property
domain: User
range: string

email
type: Property
domain: User
range: string

isActive
type: Property
domain: User
range: boolean

isVerified
type: Property
domain: User
range: boolean

firstName
type: Property
domain: User
range: string

lastName
type: Property
domain: User
range: string

displayName
type: Property
domain: User
range: string

privacySetting
type: Property
domain: User
range: integer

picture
type: Property
domain: User
max cardinality: 1
range: FileObject

projects
type: Property
domain: User
range: Project

memberships
type: Property
domain: User
range: ProjectMember

organizationMemberships
type: Property
domain: User
range: OrganizationMember

userLikes
type: Property
domain: User
range: ProjectLike

receivesNewsletter
type: Property
domain: User
range: boolean

zooniverseUsername
type: Property
domain: User
range: string

sciStarterId
type: Property
domain: User
range: string

isAirtable
type: Property
domain: User
range: boolean

isAirtableExpired
type: Property
domain: User
range: boolean

createdAt
type: Property
domain: User
range: dateTime

updatedAt
type: Property
domain: User
range: dateTime

changeEmailPending
type: Property
domain: User
range: boolean

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Area resources
  title: The collection of Area resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Datasheet resources
  title: The collection of Datasheet resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DatasheetRecord resources
  title: The collection of DatasheetRecord resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DatasheetZooniverseHistory resources
  title: The collection of DatasheetZooniverseHistory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FileObject resources
  title: The collection of FileObject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Notification resources
  title: The collection of Notification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of NotificationPreference resources
  title: The collection of NotificationPreference resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Observation resources
  title: The collection of Observation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ObservationRecord resources
  title: The collection of ObservationRecord resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Organism resources
  title: The collection of Organism resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Organization resources
  title: The collection of Organization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OrganizationMember resources
  title: The collection of OrganizationMember resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OrganizationProject resources
  title: The collection of OrganizationProject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OrganizationResource resources
  title: The collection of OrganizationResource resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Project resources
  title: The collection of Project resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectAirtableHistory resources
  title: The collection of ProjectAirtableHistory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectDownload resources
  title: The collection of ProjectDownload resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectLike resources
  title: The collection of ProjectLike resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectMember resources
  title: The collection of ProjectMember resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectMemberInvite resources
  title: The collection of ProjectMemberInvite resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectMemberLocation resources
  title: The collection of ProjectMemberLocation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectPost resources
  title: The collection of ProjectPost resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectResource resources
  title: The collection of ProjectResource resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ProjectSciStarterHistory resources
  title: The collection of ProjectSciStarterHistory resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of RecordOrganism resources
  title: The collection of RecordOrganism resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Scorecard resources
  title: The collection of Scorecard resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Stat resources
  title: The collection of Stat resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Topics resources
  title: The collection of Topics resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Area resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Area
supported operation: Creates a Area resource.
  type: Operation
  type: CreateAction
  expects: Area
  method: POST
  title: Creates a Area resource.
  returns: Area
supported operation: Retrieves the collection of Area resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Area resources.
  returns: Collection

The collection of Datasheet resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Datasheet
supported operation: Retrieves the collection of Datasheet resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Datasheet resources.
  returns: Collection
supported operation: Creates a Datasheet resource.
  type: Operation
  type: CreateAction
  expects: Datasheet
  method: POST
  title: Creates a Datasheet resource.
  returns: Datasheet
supported operation: Retrieves the collection of Datasheet resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Datasheet resources.
  returns: Collection

The collection of DatasheetRecord resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DatasheetRecord
supported operation: Creates a DatasheetRecord resource.
  type: Operation
  type: CreateAction
  expects: DatasheetRecord
  method: POST
  title: Creates a DatasheetRecord resource.
  returns: DatasheetRecord
supported operation: Retrieves the collection of DatasheetRecord resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DatasheetRecord resources.
  returns: Collection
supported operation: Retrieves the collection of DatasheetRecord resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DatasheetRecord resources.
  returns: Collection

The collection of DatasheetZooniverseHistory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DatasheetZooniverseHistory
supported operation: Retrieves the collection of DatasheetZooniverseHistory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DatasheetZooniverseHistory resources.
  returns: Collection

The collection of FileObject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FileObject
supported operation: Creates a FileObject resource.
  type: Operation
  type: CreateAction
  expects: MediaObject
  method: POST
  title: Creates a FileObject resource.
  returns: MediaObject
supported operation: Retrieves the collection of FileObject resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FileObject resources.
  returns: Collection
supported operation: Creates a FileObject resource.
  type: Operation
  type: CreateAction
  expects: MediaObject
  method: POST
  title: Creates a FileObject resource.
  returns: MediaObject

The collection of Notification resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Notification
supported operation: Retrieves the collection of Notification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Notification resources.
  returns: Collection
supported operation: Creates a Notification resource.
  type: Operation
  type: CreateAction
  expects: Notification
  method: POST
  title: Creates a Notification resource.
  returns: Notification

The collection of NotificationPreference resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NotificationPreference
supported operation: Creates a NotificationPreference resource.
  type: Operation
  type: CreateAction
  expects: NotificationPreference
  method: POST
  title: Creates a NotificationPreference resource.
  returns: NotificationPreference
supported operation: Retrieves the collection of NotificationPreference resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NotificationPreference resources.
  returns: Collection

The collection of Observation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Observation
supported operation: Creates a Observation resource.
  type: Operation
  type: CreateAction
  expects: Observation
  method: POST
  title: Creates a Observation resource.
  returns: Observation
supported operation: Retrieves the collection of Observation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Observation resources.
  returns: Collection
supported operation: Retrieves the collection of Observation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Observation resources.
  returns: Collection
supported operation: Retrieves the collection of Observation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Observation resources.
  returns: Collection
supported operation: Retrieves the collection of Observation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Observation resources.
  returns: Collection
supported operation: Retrieves the collection of Observation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Observation resources.
  returns: Collection

The collection of ObservationRecord resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ObservationRecord
supported operation: Creates a ObservationRecord resource.
  type: Operation
  type: CreateAction
  expects: ObservationRecord
  method: POST
  title: Creates a ObservationRecord resource.
  returns: ObservationRecord

The collection of Organism resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organism
supported operation: Retrieves the collection of Organism resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organism resources.
  returns: Collection

The collection of Organization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organization
supported operation: Creates a Organization resource.
  type: Operation
  type: CreateAction
  expects: Organization
  method: POST
  title: Creates a Organization resource.
  returns: Organization
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  returns: Collection

The collection of OrganizationMember resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrganizationMember
supported operation: Retrieves the collection of OrganizationMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationMember resources.
  returns: Collection
supported operation: Retrieves the collection of OrganizationMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationMember resources.
  returns: Collection

The collection of OrganizationProject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrganizationProject
supported operation: Creates a OrganizationProject resource.
  type: Operation
  type: CreateAction
  expects: OrganizationProject
  method: POST
  title: Creates a OrganizationProject resource.
  returns: OrganizationProject
supported operation: Retrieves the collection of OrganizationProject resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationProject resources.
  returns: Collection
supported operation: Retrieves the collection of OrganizationProject resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationProject resources.
  returns: Collection

The collection of OrganizationResource resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrganizationResource
supported operation: Creates a OrganizationResource resource.
  type: Operation
  type: CreateAction
  expects: OrganizationResource
  method: POST
  title: Creates a OrganizationResource resource.
  returns: OrganizationResource
supported operation: Retrieves the collection of OrganizationResource resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrganizationResource resources.
  returns: Collection

The collection of Project resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Creates a Project resource.
  type: Operation
  type: CreateAction
  expects: Project
  method: POST
  title: Creates a Project resource.
  returns: Project
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  returns: Collection
supported operation: Retrieves the collection of Project resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Project resources.
  returns: Collection

The collection of ProjectAirtableHistory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectAirtableHistory
supported operation: Creates a ProjectAirtableHistory resource.
  type: Operation
  type: CreateAction
  expects: ProjectAirtableHistory
  method: POST
  title: Creates a ProjectAirtableHistory resource.
  returns: ProjectAirtableHistory
supported operation: Retrieves the collection of ProjectAirtableHistory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectAirtableHistory resources.
  returns: Collection

The collection of ProjectDownload resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectDownload
supported operation: Creates a ProjectDownload resource.
  type: Operation
  type: CreateAction
  expects: ProjectDownload
  method: POST
  title: Creates a ProjectDownload resource.
  returns: ProjectDownload
supported operation: Retrieves the collection of ProjectDownload resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectDownload resources.
  returns: Collection

The collection of ProjectLike resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectLike
supported operation: Creates a ProjectLike resource.
  type: Operation
  type: CreateAction
  expects: ProjectLike
  method: POST
  title: Creates a ProjectLike resource.
  returns: ProjectLike

The collection of ProjectMember resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectMember
supported operation: Creates a ProjectMember resource.
  type: Operation
  type: CreateAction
  expects: ProjectMember
  method: POST
  title: Creates a ProjectMember resource.
  returns: ProjectMember
supported operation: Retrieves the collection of ProjectMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMember resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMember resources.
  returns: Collection

The collection of ProjectMemberInvite resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectMemberInvite
supported operation: Retrieves the collection of ProjectMemberInvite resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberInvite resources.
  returns: Collection
supported operation: Creates a ProjectMemberInvite resource.
  type: Operation
  type: CreateAction
  expects: ProjectMemberInvite
  method: POST
  title: Creates a ProjectMemberInvite resource.
  returns: ProjectMemberInvite
supported operation: Retrieves the collection of ProjectMemberInvite resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberInvite resources.
  returns: Collection

The collection of ProjectMemberLocation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectMemberLocation
supported operation: Creates a ProjectMemberLocation resource.
  type: Operation
  type: CreateAction
  expects: ProjectMemberLocation
  method: POST
  title: Creates a ProjectMemberLocation resource.
  returns: ProjectMemberLocation
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectMemberLocation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectMemberLocation resources.
  returns: Collection

The collection of ProjectPost resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectPost
supported operation: Creates a ProjectPost resource.
  type: Operation
  type: CreateAction
  expects: ProjectPost
  method: POST
  title: Creates a ProjectPost resource.
  returns: ProjectPost
supported operation: Retrieves the collection of ProjectPost resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectPost resources.
  returns: Collection
supported operation: Retrieves the collection of ProjectPost resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectPost resources.
  returns: Collection

The collection of ProjectResource resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectResource
supported operation: Creates a ProjectResource resource.
  type: Operation
  type: CreateAction
  expects: ProjectResource
  method: POST
  title: Creates a ProjectResource resource.
  returns: ProjectResource
supported operation: Retrieves the collection of ProjectResource resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectResource resources.
  returns: Collection

The collection of ProjectSciStarterHistory resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProjectSciStarterHistory
supported operation: Retrieves the collection of ProjectSciStarterHistory resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProjectSciStarterHistory resources.
  returns: Collection

The collection of RecordOrganism resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: RecordOrganism
supported operation: Retrieves the collection of RecordOrganism resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of RecordOrganism resources.
  returns: Collection

The collection of Scorecard resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Scorecard
supported operation: Creates a Scorecard resource.
  type: Operation
  type: CreateAction
  expects: Scorecard
  method: POST
  title: Creates a Scorecard resource.
  returns: Scorecard
supported operation: Retrieves the collection of Scorecard resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Scorecard resources.
  returns: Collection

The collection of Stat resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Stat
supported operation: Retrieves the collection of Stat resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Stat resources.
  returns: Collection

The collection of Topics resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Topics
supported operation: Retrieves the collection of Topics resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Topics resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

SupportedProperty
property: measurementsTotal
title: measurementsTotal
required: false
readable: true
writeable: false
description: The total number of measurements of the project.

SupportedProperty
property: organizationProjects
title: organizationProjects
required: false
readable: true
writeable: false
description: The organizations this project belongs to

SupportedProperty
property: organizations
title: organizations
required: false
readable: true
writeable: false

SupportedProperty
property: announcement
title: announcement
required: false
readable: true
writeable: true
description: The project announcement

SupportedProperty
property: announcementDate
title: announcementDate
required: false
readable: true
writeable: false
description: The date the announcement was recorded

SupportedProperty
property: topics
title: topics
required: false
readable: true
writeable: true
description: The topics associated with this project, stored as a json object

SupportedProperty
property: lastObservationDatetime
title: lastObservationDatetime
required: false
readable: true
writeable: false
description: The date the last observation was submitted to this project

SupportedProperty
property: createdAt
title: createdAt
required: false
readable: true
writeable: false

SupportedProperty
property: updatedAt
title: updatedAt
required: false
readable: true
writeable: false

Retrieves a Project resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Project resource.
returns: Project

Replaces the Project resource.
type: Operation
type: ReplaceAction
expects: Project
method: PUT
title: Replaces the Project resource.
returns: Project

Updates the Project resource.
type: Operation
expects: Project
method: PATCH
title: Updates the Project resource.
returns: Project

Retrieves a Project resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Project resource.
returns: Project

Retrieves a Project resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Project resource.
returns: Project

Retrieves a Project resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Project resource.
returns: Project

Retrieves a Project resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Project resource.
returns: Project