projectmanagement/project/put

Create a new or update an existing project record.

Parameters

NameRequiredDefaultDescriptionExample
projectIDfalseproject id, supply to edit an existing project; otherwise, do not include when adding a new project146789
namefalseproject nameECM Matthew
userGroupfalseuser group for this project; corresponds to a portal user group name
objectPartfalseobject part for this project; limits project to a portion of each objectMatthew
documentGroupIDfalsedocument group id for this project; limits primary project activity (e.g., transcribing) to a list of documents7
secondaryDocumentGroupIDfalsesecondary document group id for this project; limits secondary (e.g., editing) activity of a project to a list of documents7
tertiaryDocumentGroupIDfalsetertiary document group id for this project; limits tertiary (e.g., indexing) activity of a project to a list of documents7
taskTypeIDfalseprimary task type id for this project (1-imaging; 2-indexing; 3-transcribing; 4-variant selection)3
restrictApparatusIDfalse0restriction level for the apparatus of this project (visibility: 0-public; 1-expert access; 2-project members)1
configurationfalseproject-specific configuration data; typically not required. this can be used for storing and passing on task tool-specific configuration
transcriptionAttributionfalsecredit to include with project transcription
apparatusAttributionfalsecredit to include with project apparatus
transcriptionBaseDefaultfalsebasetext to use for transcribing. docID or 'CrossWire:ModuleName'CrossWire:MOTBTR
editionBaseDefaultfalseedition text to use for collation and final display. docID or 'CrossWire:ModuleName1010100
documentRestrictQueryfalsequery parameters to add to each document query requestdocID=10000-49999&featureCode=LiturgicalBookType%3DDaily
taskStageDefinitionsfalsecustom project task stages defined
formatfalsespecified at session openresponse output format (json|xml|csv|gchart)json

Errors

Must be logged in.-5