Skip to content

Latest commit

 

History

History
1903 lines (774 loc) · 25.8 KB

workobjects-all.schema.md

File metadata and controls

1903 lines (774 loc) · 25.8 KB
Raw

Workfront Work Objects Schema

https://ns.adobe.com/experience/workfront/workobjects-all

High level field group that brings in all available work objects.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted adobe/experience/workfront/workobjects-all.schema.json

Schema Hierarchy

Workfront Work Objects Example

{
  "workfront:storyPoints": 5,
  "workfront:status": "New"
}

Workfront Work Objects Properties

Property Type Required Defined by
workfront:category object Optional Workfront Category Attributes
workfront:categoryparameter object Optional Workfront Category Attributes
workfront:opTask object Optional Workfront Opperational Task Attributes
workfront:portfolio object Optional Workfront Portfolio Attributes
workfront:program object Optional Workfront Program Attributes
workfront:project object Optional Workfront Project Attributes
workfront:task object Optional Workfront Task Attributes
* any Additional this schema allows additional properties

workfront:category

Category Attributes

workfront:category

workfront:category Type

object with following properties:

Property Type Required
workfront:description string Optional
workfront:groupID string Optional
workfront:isActive boolean Optional
workfront:objectCode string Optional

workfront:description

Category Description

Description of the wf category object

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:groupID

Category's Group ID

Group id this category belongs to

workfront:groupID

  • is optional
  • type: string
workfront:groupID Type

string

workfront:isActive

Category is Active

Flag that describes if category is active

workfront:isActive

  • is optional
  • type: boolean
workfront:isActive Type

boolean

workfront:objectCode

Category's object code

Object code for category

workfront:objectCode

  • is optional
  • type: string
workfront:objectCode Type

string

workfront:categoryparameter

Category Parameter Attributes

workfront:categoryparameter

workfront:categoryparameter Type

object with following properties:

Property Type Required
workfront:categoryParameterExpressionID string Optional
workfront:parameterGroupID string Optional
workfront:parameterID string Optional
workfront:securityLevel string Optional
workfront:viewSecurityLevel string Optional

workfront:categoryParameterExpressionID

Category Parameter Expression ID

Expression ID of category parameter

workfront:categoryParameterExpressionID

  • is optional
  • type: string
workfront:categoryParameterExpressionID Type

string

workfront:parameterGroupID

Parameter Group ID

Group ID to which the category parameter belongs to

workfront:parameterGroupID

  • is optional
  • type: string
workfront:parameterGroupID Type

string

workfront:parameterID

Parameter ID

Parameter ID of category parameter object

workfront:parameterID

  • is optional
  • type: string
workfront:parameterID Type

string

workfront:securityLevel

Security Level

Security level the category parameter belongs to

workfront:securityLevel

  • is optional
  • type: string
workfront:securityLevel Type

string

workfront:viewSecurityLevel

View Security Level

Security level view

workfront:viewSecurityLevel

  • is optional
  • type: string
workfront:viewSecurityLevel Type

string

workfront:opTask

Operational Task Attributes

workfront:opTask

workfront:opTask Type

object with following properties:

Property Type Required
workfront:actualCompletionTimestamp string Optional
workfront:actualDurationMinutes number Optional
workfront:actualStartTimestamp string Optional
workfront:assignedToEmployeeID string Optional
workfront:condition string Optional
workfront:description string Optional
workfront:iterationID string Optional
workfront:opTaskType string Optional
workfront:ownerEmployeeID string Optional
workfront:percentComplete number Optional
workfront:plannedCompletionTimestamp string Optional
workfront:plannedStartTimestamp string Optional
workfront:priority string Optional
workfront:status string Optional
workfront:storyPoints number Optional
workfront:teamID string Optional

workfront:actualCompletionTimestamp

OpTask Actual Completion Timestamp

workfront:actualCompletionTimestamp

  • is optional
  • type: string
workfront:actualCompletionTimestamp Type

string

workfront:actualDurationMinutes

OpTask Actual Duration Minutes

workfront:actualDurationMinutes

  • is optional
  • type: number
workfront:actualDurationMinutes Type

number

workfront:actualStartTimestamp

OpTask Actual Start Timestamp

workfront:actualStartTimestamp

  • is optional
  • type: string
workfront:actualStartTimestamp Type

string

workfront:assignedToEmployeeID

OpTask Assigned To Employee ID

workfront:assignedToEmployeeID

  • is optional
  • type: string
workfront:assignedToEmployeeID Type

string

workfront:condition

OpTask Condition

workfront:condition

  • is optional
  • type: string
workfront:condition Type

string

workfront:description

OpTask Description

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:iterationID

OpTask Iteration ID

workfront:iterationID

  • is optional
  • type: string
workfront:iterationID Type

string

workfront:opTaskType

Operational Task Type

workfront:opTaskType

  • is optional
  • type: string
workfront:opTaskType Type

string

workfront:ownerEmployeeID

OpTask Owner Employee ID

workfront:ownerEmployeeID

  • is optional
  • type: string
workfront:ownerEmployeeID Type

string

workfront:percentComplete

OpTask Percent Complete

workfront:percentComplete

  • is optional
  • type: number
workfront:percentComplete Type

number

workfront:plannedCompletionTimestamp

OpTask Planned Completion Timestamp

workfront:plannedCompletionTimestamp

  • is optional
  • type: string
workfront:plannedCompletionTimestamp Type

string

workfront:plannedStartTimestamp

OpTask Planned Start Timestamp

workfront:plannedStartTimestamp

  • is optional
  • type: string
workfront:plannedStartTimestamp Type

string

workfront:priority

OpTask Priority

workfront:priority

  • is optional
  • type: string
workfront:priority Type

string

workfront:status

OpTask Status

workfront:status

  • is optional
  • type: string
workfront:status Type

string

workfront:storyPoints

OpTask Story Points

workfront:storyPoints

  • is optional
  • type: number
workfront:storyPoints Type

number

workfront:teamID

OpTask Team ID

workfront:teamID

  • is optional
  • type: string
workfront:teamID Type

string

workfront:portfolio

Portfolio Attributes

workfront:portfolio

workfront:portfolio Type

object with following properties:

Property Type Required
workfront:budget number Optional
workfront:description string Optional
workfront:isActive boolean Optional
workfront:ownerEmployeeID string Optional

workfront:budget

Portfolio Budget

workfront:budget

  • is optional
  • type: number
workfront:budget Type

number

workfront:description

Portfolio Description

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:isActive

Portfolio Is Active

workfront:isActive

  • is optional
  • type: boolean
workfront:isActive Type

boolean

workfront:ownerEmployeeID

Portfolio Owner Employee ID

workfront:ownerEmployeeID

  • is optional
  • type: string
workfront:ownerEmployeeID Type

string

workfront:program

Program Attributes

workfront:program

workfront:program Type

object with following properties:

Property Type Required
workfront:description string Optional
workfront:isActive boolean Optional
workfront:ownerEmployeeID string Optional

workfront:description

Program Description

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:isActive

Program is Active

workfront:isActive

  • is optional
  • type: boolean
workfront:isActive Type

boolean

workfront:ownerEmployeeID

Program Owner Employee ID

workfront:ownerEmployeeID

  • is optional
  • type: string
workfront:ownerEmployeeID Type

string

workfront:project

Project Attributes

workfront:project

workfront:project Type

object with following properties:

Property Type Required
workfront:actualCompletionTimestamp string Optional
workfront:actualStartTimestamp string Optional
workfront:budget number Optional
workfront:condition string Optional
workfront:description string Optional
workfront:displayOrder integer Optional
workfront:durationMinutes number Optional
workfront:estimatedCompletionTimestamp string Optional
workfront:estimatedStartTimestamp string Optional
workfront:groupID string Optional
workfront:milestonePathID string Optional
workfront:ownerEmployeeID string Optional
workfront:percentComplete number Optional
workfront:plannedCompletionTimestamp string Optional
workfront:plannedStartTimestamp string Optional
workfront:priority string Optional
workfront:projectedCompletionTimestamp string Optional
workfront:projectedStartTimestamp string Optional
workfront:status string Optional
workfront:teamID string Optional

workfront:actualCompletionTimestamp

Project Actual Completion Timestamp

workfront:actualCompletionTimestamp

  • is optional
  • type: string
workfront:actualCompletionTimestamp Type

string

workfront:actualStartTimestamp

Project Actual Start Timestamp

workfront:actualStartTimestamp

  • is optional
  • type: string
workfront:actualStartTimestamp Type

string

workfront:budget

Project Budget

workfront:budget

  • is optional
  • type: number
workfront:budget Type

number

workfront:condition

Project Condition

workfront:condition

  • is optional
  • type: string
workfront:condition Type

string

workfront:description

Project Description

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:displayOrder

Project Display Order

workfront:displayOrder

  • is optional
  • type: integer
workfront:displayOrder Type

integer

workfront:durationMinutes

Project Duration Minutes

workfront:durationMinutes

  • is optional
  • type: number
workfront:durationMinutes Type

number

workfront:estimatedCompletionTimestamp

Project Estimated Completion Timestamp

workfront:estimatedCompletionTimestamp

  • is optional
  • type: string
workfront:estimatedCompletionTimestamp Type

string

workfront:estimatedStartTimestamp

Project Estimated Start Timestamp

workfront:estimatedStartTimestamp

  • is optional
  • type: string
workfront:estimatedStartTimestamp Type

string

workfront:groupID

Project Group ID

workfront:groupID

  • is optional
  • type: string
workfront:groupID Type

string

workfront:milestonePathID

Project Milestone Path ID

workfront:milestonePathID

  • is optional
  • type: string
workfront:milestonePathID Type

string

workfront:ownerEmployeeID

Project Owner Employee ID

workfront:ownerEmployeeID

  • is optional
  • type: string
workfront:ownerEmployeeID Type

string

workfront:percentComplete

Project Percent Complete

workfront:percentComplete

  • is optional
  • type: number
workfront:percentComplete Type

number

workfront:plannedCompletionTimestamp

Project Planned Completion Timestamp

workfront:plannedCompletionTimestamp

  • is optional
  • type: string
workfront:plannedCompletionTimestamp Type

string

workfront:plannedStartTimestamp

Project Planned Start Timestamp

workfront:plannedStartTimestamp

  • is optional
  • type: string
workfront:plannedStartTimestamp Type

string

workfront:priority

Project Priority

workfront:priority

  • is optional
  • type: string
workfront:priority Type

string

workfront:projectedCompletionTimestamp

Project Projected Completion Timestamp

workfront:projectedCompletionTimestamp

  • is optional
  • type: string
workfront:projectedCompletionTimestamp Type

string

workfront:projectedStartTimestamp

Project Projected Start Timestamp

workfront:projectedStartTimestamp

  • is optional
  • type: string
workfront:projectedStartTimestamp Type

string

workfront:status

Project Status

workfront:status

  • is optional
  • type: string
workfront:status Type

string

workfront:teamID

Project Team ID

workfront:teamID

  • is optional
  • type: string
workfront:teamID Type

string

workfront:task

Task Attributes

workfront:task

workfront:task Type

object with following properties:

Property Type Required
workfront:actualCompletionTimestamp string Optional
workfront:actualDurationMinutes number Optional
workfront:actualStartTimestamp string Optional
workfront:assignedToEmployeeID string Optional
workfront:condition string Optional
workfront:description string Optional
workfront:durationMinutes number Optional
workfront:estimatedCompletionTimestamp string Optional
workfront:estimatedStartTimestamp string Optional
workfront:groupID string Optional
workfront:hierarchyIndentLevel integer Optional
workfront:isCritical boolean Optional
workfront:iterationID string Optional
workfront:milestoneID string Optional
workfront:numberOfChildren integer Optional
workfront:numberOfOpenOpTasks integer Optional
workfront:originalDurationMinutes number Optional
workfront:parentTaskID string Optional
workfront:percentComplete number Optional
workfront:plannedCompletionTimestamp string Optional
workfront:plannedDurationMinutes number Optional
workfront:plannedStartTimestamp string Optional
workfront:priority string Optional
workfront:projectedCompletionTimestamp string Optional
workfront:projectedStartTimestamp string Optional
workfront:status string Optional
workfront:storyPoints number Optional
workfront:teamID string Optional

workfront:actualCompletionTimestamp

Task Actual Completion Timestamp

workfront:actualCompletionTimestamp

  • is optional
  • type: string
workfront:actualCompletionTimestamp Type

string

workfront:actualDurationMinutes

Task Actual Duration Minutes

workfront:actualDurationMinutes

  • is optional
  • type: number
workfront:actualDurationMinutes Type

number

workfront:actualStartTimestamp

Task Actual Start Timestamp

workfront:actualStartTimestamp

  • is optional
  • type: string
workfront:actualStartTimestamp Type

string

workfront:assignedToEmployeeID

Task Assigned To Employee ID

workfront:assignedToEmployeeID

  • is optional
  • type: string
workfront:assignedToEmployeeID Type

string

workfront:condition

Task Condition

workfront:condition

  • is optional
  • type: string
workfront:condition Type

string

workfront:description

Task Description

workfront:description

  • is optional
  • type: string
workfront:description Type

string

workfront:durationMinutes

Task Duration Minutes

workfront:durationMinutes

  • is optional
  • type: number
workfront:durationMinutes Type

number

workfront:estimatedCompletionTimestamp

Task Estimated Completion Timestamp

workfront:estimatedCompletionTimestamp

  • is optional
  • type: string
workfront:estimatedCompletionTimestamp Type

string

workfront:estimatedStartTimestamp

Task Estimated Start Timestamp

workfront:estimatedStartTimestamp

  • is optional
  • type: string
workfront:estimatedStartTimestamp Type

string

workfront:groupID

Task Group ID

workfront:groupID

  • is optional
  • type: string
workfront:groupID Type

string

workfront:hierarchyIndentLevel

Task Hierarchy Indent Level

workfront:hierarchyIndentLevel

  • is optional
  • type: integer
workfront:hierarchyIndentLevel Type

integer

workfront:isCritical

Task Is Critical

workfront:isCritical

  • is optional
  • type: boolean
workfront:isCritical Type

boolean

workfront:iterationID

Iteration ID

workfront:iterationID

  • is optional
  • type: string
workfront:iterationID Type

string

workfront:milestoneID

Task Milestone ID

workfront:milestoneID

  • is optional
  • type: string
workfront:milestoneID Type

string

workfront:numberOfChildren

Task Number of Children

workfront:numberOfChildren

  • is optional
  • type: integer
workfront:numberOfChildren Type

integer

workfront:numberOfOpenOpTasks

Task Number of Open OpTasks

workfront:numberOfOpenOpTasks

  • is optional
  • type: integer
workfront:numberOfOpenOpTasks Type

integer

workfront:originalDurationMinutes

Task Original Duration Minutes

workfront:originalDurationMinutes

  • is optional
  • type: number
workfront:originalDurationMinutes Type

number

workfront:parentTaskID

Parent Task ID

workfront:parentTaskID

  • is optional
  • type: string
workfront:parentTaskID Type

string

workfront:percentComplete

Task Percent Complete

workfront:percentComplete

  • is optional
  • type: number
workfront:percentComplete Type

number

workfront:plannedCompletionTimestamp

Task Planned Completion Timestamp

workfront:plannedCompletionTimestamp

  • is optional
  • type: string
workfront:plannedCompletionTimestamp Type

string

workfront:plannedDurationMinutes

Task Planned Duration Minutes

workfront:plannedDurationMinutes

  • is optional
  • type: number
workfront:plannedDurationMinutes Type

number

workfront:plannedStartTimestamp

Task Planned Start Timestamp

workfront:plannedStartTimestamp

  • is optional
  • type: string
workfront:plannedStartTimestamp Type

string

workfront:priority

Task Priority

workfront:priority

  • is optional
  • type: string
workfront:priority Type

string

workfront:projectedCompletionTimestamp

Task Projected Completion Timestamp

workfront:projectedCompletionTimestamp

  • is optional
  • type: string
workfront:projectedCompletionTimestamp Type

string

workfront:projectedStartTimestamp

Task Projected Start Timestamp

workfront:projectedStartTimestamp

  • is optional
  • type: string
workfront:projectedStartTimestamp Type

string

workfront:status

Task Status

workfront:status

  • is optional
  • type: string
workfront:status Type

string

workfront:storyPoints

Task Story Points

workfront:storyPoints

  • is optional
  • type: number
workfront:storyPoints Type

number

workfront:teamID

Task Team ID

workfront:teamID

  • is optional
  • type: string
workfront:teamID Type

string