Skip to main content

ObjFileSourceUnion

Union containing file source type-specific data for an ObjFileSource.

NameDescriptionType
blank_templateBlank template object file source.BlankTemplateData
user_defined_templateUser defined template object file source.UserDefinedTemplateData
uploaded_fileUploaded object file source.UploadedFileData
uploaded_filesUploaded object file source with multiple files.UploadedFilesData
empty_filesEmpty object file source (one or more files). Only the title and extension of each file are known;
there is no upload id or size because the file contents have not been uploaded yet. This type may only
be used when the object is created as a draft (the draft flag must be set); otherwise the request is
rejected.
EmptyFilesData
file_contentInline file content object file source.FileContentData

Examples​

/* ObjFileSource for blank_template */
{
"blank_template": {
"name": "<name>"
}
}
/* ObjFileSource for user_defined_template */
{
"user_defined_template": {
"obj_id": {
"type": 0,
"item_id": {
"internal_id": 0,
"external_repository_id": {
"connection": "<connection>",
"item": "<item>"
}
}
}
}
}
/* ObjFileSource for uploaded_file */
{
"uploaded_file": {
"upload_id": 0,
"title": "<title>",
"extension": "<extension>",
"size": 0
}
}
/* ObjFileSource for uploaded_files */
{
"uploaded_files": {
"uploaded_file_array": [] /* Array of UploadedFile */
}
}
/* ObjFileSource for empty_files */
{
"empty_files": {
"empty_file_array": [] /* Array of EmptyFile */
}
}
/* ObjFileSource for file_content */
{
"file_content": {
"title": "<title>",
"extension": "<extension>",
"file_data": 0 /*Uint8Array*/
}
}