HubSpot: Source code schemas

← Source code operations · All schemas

Create a file — response body

Field	Type	Presence	Description and constraints
$	object	Root
archivedAt	JSON	Optional
archivedAt (anyOf 1)	integer	Alternative	Timestamp of when the object was archived (deleted). Format: int64
archivedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
children	array	Optional	If the object is a folder, contains the filenames of the files within the folder.
children[]	string	Each item
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	Timestamp of when the object was first created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
folder	boolean	Required within parent	Determines whether or not this path points to a folder.
hash	string	Optional	A unique identifier for the file's content, used to verify data integrity.
id	string	Required within parent	The path of the file in the CMS Developer File System.
name	string	Required within parent	The name of the file.
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	Timestamp of when the object was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Extract a zip file — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
path	string	Required within parent	The file system location where the zip file is to be extracted.

Extract a zip file — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the task.
links	object	Optional	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys

Get extraction status — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp indicating when the action was completed. Format: date-time
links	object	Optional	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp indicating when the action was requested. Format: date-time
startedAt	string	Required within parent	The timestamp indicating when the action was started. Format: date-time
status	string	Required within parent	The current status of the action, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING. Known values: CANCELED, COMPLETE, PENDING, PROCESSING