Skip to content

Reference: Data Types

KP edited this page May 2, 2013 · 8 revisions

Reference: Data Types

addressing

Value: [array] of {dictionary}

[  
  {  
    'type': 'HumanUser' | 'Group',  
    'id': int,  
    ...  
  },  
  ...  
]

checkbox

Value: boolean: True | False

color

Value: string: (255,0,0) | pipeline_step
Note: pipeline_step indicates the Task color inherits from the Pipeline Step color

currency

Value: double | None
Range: -9999999999999.99, 9999999999999.99

date

Value: string "YYYY-MM-DD" | None
Range: Year must be >= 1970

date_time

Value: datetime object | None
Range: Year must be >= 1970
Note: automatically converts between client local time and UTC (datetimes are stored as UTC on the server)

duration

Value: int | None Range: -2147483648, 2147483647
Note: Length of time, in minutes

entity

Value: {dictionary} | None

{  
  'type': "string",  
  'id': int,  
  ...  
}

float

Value: double | None
Range: -999999999.999999, 999999999.999999

footage

Value: string "FF-ff" | None
Range: Frames must be < Preferences value for "Advanced > Number of frames per foot of film"
Note: Format matches Preference value for "Formatting > Display of footage fields". Example above is default.F=Feet f=Frames.

image (read-only)

Value: "string" | None

list

Value: "string" | None

multi_entity

Value: [array] of {dictionary}

[  
  {  
    'type': "string",  
    'id': int,  
    ...  
  },  
  ...  
]

number

Value: int | None
Range: -2147483648, 2147483647

password

Value: "string" | None Note: returned values of password fields are replaced with '*******' for security

percent

Value: int | None
Range: -2147483648, 2147483647

serializable

Value: {dictionary} | None

status_list

Value: "string" | None

system_task_type (deprecated)

Value: "string" | None

tag_list

Value: [array] of "string"

text

Value: "string" | None

timecode

Value: int | None
Range: -2147483648, 2147483647
Note: Length of time, in milliseconds (1000 = 1 second)

url (file/link field)

Value: {dictionary} | None

{  
  'content_type': "string", 
  'link_type': "local" | "url" | "upload",  
  'name': "string",  
  'url': "string" 
}

Local Files (additional keys exist for local file links)
Value: {dictionary} | None

{  
  'content_type': "string", 
  'link_type': "local",  
  'local_path': "string" | None, 
  'local_path_linux': "string" | None, 
  'local_path_mac': "string" | None, 
  'local_path_windows': "string" | None, 
  'local_storage': {dictionary}, 
  'name': "string",  
  'url': "string", 
}

API versions < v3.0.3:

{  
  'url': "string",  
  'name': "string",  
  'content_type': "string"
}
Clone this wiki locally