Box
83 min
the box connector allows for streamlined automation of content management functions, enabling secure file sharing and collaboration within enterprise workflows box is a cloud content management and file sharing service for businesses the box connector for swimlane turbine enables automated interactions with box, allowing users to manage files, folders, collaborations, and events within their box environment by integrating with box, swimlane turbine users can streamline content workflows, enhance collaboration security, and maintain a seamless data exchange across their security ecosystem this connector empowers users to perform a variety of actions such as uploading files, managing upload sessions, and retrieving file or folder details, all within the swimlane platform the box api to interact with various aspects of the box content collaboration product this connector focuses on apis related to files, collaborations, users, events, folders, shared links, search, workflow, groups, and upload prerequisites to utilize the box connector within swimlane turbine, ensure you have the following prerequisites oauth 2 0 authentication with the following parameters url endpoint for box api services access token token used to authenticate api requests custom authentication with the following parameters url endpoint for box api services client id unique identifier for the application using the box api client secret secret key associated with the client id for authentication grant type type of oauth grant requested (e g , client credentials) note https //developer box com/reference/post oauth2 token/ https //developer box com/guides/authentication/oauth2/ the swimlane team will provide a python script and instructions on how to use the script to generate the access token using oauth2 0 capabilities this connector provides the following capabilities commit upload session create upload session for existing file create upload session get collaborations get events get file from shared link get file get folder for shared link get group get list items in folder get list parts get metadata query get upload session get user get workflows and so on note interact with files https //developer box com/reference/get files id/ manage collaborations https //developer box com/reference/get collaborations id/ manage users https //developer box com/reference/get users id/ handle events https //developer box com/reference/get events/ manage folders https //developer box com/reference/get folders id items/ handle shared links (folders) https //developer box com/reference/get shared items folders/ handle shared links (files) https //developer box com/reference/get shared items/ execute search https //developer box com/reference/get metadata query indices/ handle workflow https //developer box com/reference/get workflows/ manage groups https //developer box com/reference/get groups id/ handle uploads https //developer box com/reference/post files content/ handle chunked uploads https //developer box com/reference/get files upload sessions id/ configurations box authentication using oauth2 0 configuration parameters parameter description type required url a url to the target host string required access token the access token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional box authentication configuration parameters parameter description type required url a url to the target host string required client id the client id string required client secret the client secret string required actor token the actor token string optional actor token type the actor token type string optional assertion the assertion string optional box shared link the box shared link string optional box subject id the box subject id string optional box subject type the box subject type string optional code the code string optional grant type the grant type string required refresh token the refresh token string optional resource the resource string optional scope the scope string optional subject token the subject token string optional subject token type the subject token type string optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions commit upload session closes an active upload session using the 'upload session id' and creates a file from the uploaded parts in box endpoint url /files/upload sessions/{{upload session id}}/commit method post input argument name type required description path parameters upload session id string required parameters for the commit upload session action headers object required http headers for the request headers digest string required http headers for the request headers if match string optional http headers for the request headers if none match string optional http headers for the request parts array optional parameter for commit upload session parts part id string required unique identifier parts offset number required parameter for commit upload session parts size number required parameter for commit upload session parts sha1 string required parameter for commit upload session input example {"json body" {"parts" \[{"part id" "bfdf5379","offset" 0,"size" 8388608,"sha1" "134b65991ed521fcfe4724b7d814ab8ded5185dc"}]},"path parameters" {"upload session id" "d5e3f7a"},"headers" {"digest" "sha=fpryg5evqletdzqekaflqwbxjzm=","if match" "1","if none match" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase entries array output field entries entries id string unique identifier entries etag string output field entries etag entries type string type of the resource entries sequence id string unique identifier entries name string name of the resource entries sha1 string output field entries sha1 entries file version object output field entries file version entries file version id string unique identifier entries file version type string type of the resource entries file version sha1 string output field entries file version sha1 entries description string output field entries description entries size number output field entries size entries path collection object output field entries path collection entries path collection total count number count value entries path collection entries array output field entries path collection entries entries path collection entries id string unique identifier entries path collection entries etag string output field entries path collection entries etag entries path collection entries type string type of the resource entries path collection entries sequence id string unique identifier entries path collection entries name string name of the resource output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"entries" \[{}]}} create upload session initiates an upload session in box for a new file, requiring the file's name, size, and target folder id endpoint url /files/upload sessions method post input argument name type required description file name string optional name of the resource file size number optional parameter for create upload session folder id string optional unique identifier input example {"json body" {"file name" "project mov","file size" 104857600,"folder id" "0"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource num parts processed number output field num parts processed part size number output field part size session endpoints object output field session endpoints session endpoints abort string output field session endpoints abort session endpoints commit string output field session endpoints commit session endpoints list parts string output field session endpoints list parts session endpoints log event string output field session endpoints log event session endpoints status string status value session endpoints upload part string output field session endpoints upload part session expires at string output field session expires at total parts number output field total parts output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "f971964745a5cd0c001bbe4e58196bfd","type" "upload session","num parts processed" 455,"part size" 1024,"session endpoints" {"abort" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","commit" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","list parts" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","log event" "htt create upload session for existing file initiates an upload session for a specified existing file on box, requiring the file's id and size endpoint url /files/{{file id}}/upload sessions method post input argument name type required description path parameters file id string required parameters for the create upload session for existing file action file name string optional name of the resource file size number optional parameter for create upload session for existing file input example {"json body" {"file name" "project mov","file size" 104857600},"path parameters" {"file id" "1234"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource num parts processed number output field num parts processed part size number output field part size session endpoints object output field session endpoints session endpoints abort string output field session endpoints abort session endpoints commit string output field session endpoints commit session endpoints list parts string output field session endpoints list parts session endpoints log event string output field session endpoints log event session endpoints status string status value session endpoints upload part string output field session endpoints upload part session expires at string output field session expires at total parts number output field total parts output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "f971964745a5cd0c001bbe4e58196bfd","type" "upload session","num parts processed" 455,"part size" 1024,"session endpoints" {"abort" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","commit" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","list parts" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","log event" "htt get collaborations retrieves details for a specific collaboration in box using the provided collaboration id endpoint url /collaborations/{{collaboration id}} method get input argument name type required description path parameters collaboration id string required parameters for the get collaborations action parameters fields array optional parameters for the get collaborations action parameters fields id string optional parameters for the get collaborations action parameters fields type string optional parameters for the get collaborations action parameters fields name string optional parameters for the get collaborations action input example {"parameters" {"fields" \[{"id" "11446498","type" "user","name" "aaron levie"}]},"path parameters" {"collaboration id" "1234"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource acceptance requirements status object status value acceptance requirements status strong password requirement object status value acceptance requirements status strong password requirement enterprise has strong password required for external users boolean status value acceptance requirements status strong password requirement user has strong password boolean status value acceptance requirements status terms of service requirement object status value acceptance requirements status terms of service requirement is accepted boolean status value acceptance requirements status terms of service requirement terms of service object status value acceptance requirements status terms of service requirement terms of service id string unique identifier acceptance requirements status terms of service requirement terms of service type string type of the resource acceptance requirements status two factor authentication requirement object status value acceptance requirements status two factor authentication requirement enterprise has two factor auth enabled boolean status value acceptance requirements status two factor authentication requirement user has two factor authentication enabled boolean status value accessible by object output field accessible by accessible by id string unique identifier accessible by type string type of the resource accessible by login string output field accessible by login accessible by name string name of the resource acknowledged at string output field acknowledged at created at string output field created at created by array output field created by created by id number unique identifier output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "12345678","type" "collaboration","acceptance requirements status" {"strong password requirement" {},"terms of service requirement" {},"two factor authentication requirement" {}},"accessible by" {"id" "11446498","type" "user","login" "ceo\@example com","name" "aaron levie"},"acknowledged at" "2012 12 12t10 55 20 08 00","created at" "2012 12 12t10 53 43 08 00","created by" \[{"id" 33224412},{"type" "user"},{"login" "dylan\@exam get events retrieves up to a year of past events for a specified user or the entire enterprise on box endpoint url /events method get input argument name type required description parameters created after string optional parameters for the get events action parameters created before string optional parameters for the get events action parameters event type string optional parameters for the get events action parameters limit number optional parameters for the get events action parameters stream position string optional parameters for the get events action parameters stream type string optional parameters for the get events action input example {"parameters" {"created after" "2012 12 12t10 53 43 08 00","created before" "2013 12 12t10 53 43 08 00","event type" "access granted","limit" 50,"stream position" "1348790499819","stream type" "all"}} output parameter type description status code number http status code of the response reason string response reason phrase chunk size number output field chunk size entries array output field entries entries type string type of the resource entries created at string output field entries created at entries recorded at string output field entries recorded at entries event id string unique identifier entries created by object output field entries created by entries created by id string unique identifier entries created by type string type of the resource entries created by name string name of the resource entries created by login string output field entries created by login entries event type string type of the resource entries session id string unique identifier entries source object output field entries source entries source id string unique identifier entries source type string type of the resource entries source name string name of the resource entries source login string output field entries source login entries source created at string output field entries source created at entries source modified at string output field entries source modified at entries source language string output field entries source language entries source timezone string output field entries source timezone entries source space amount number output field entries source space amount output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"chunk size" 2,"entries" \[{}],"next stream position" "1152922976252290886"}} get file retrieves the details of a specific file from box using the provided file id as a path parameter endpoint url /files/{{file id}} method get input argument name type required description path parameters file id string required parameters for the get file action parameters fields array optional parameters for the get file action parameters fields id string optional parameters for the get file action parameters fields type string optional parameters for the get file action parameters fields name string optional parameters for the get file action headers object optional http headers for the request headers boxapi string optional http headers for the request headers if none match string optional http headers for the request headers x rep hints string optional http headers for the request input example {"parameters" {"fields" \[{"id" "11446498","type" "user","name" "aaron levie"}]},"path parameters" {"file id" "12345"},"headers" {"boxapi" "shared link=\[link]\&shared link password=\[password]","if none match" "1","x rep hints" "\[jpg?dimensions=32x32]\[jpg?dimensions=64x64]"}} output parameter type description status code number http status code of the response reason string response reason phrase has collaborations boolean output field has collaborations is accessible via shared link boolean output field is accessible via shared link is externally owned boolean output field is externally owned is package boolean output field is package item status string status value lock object output field lock lock id string unique identifier lock type string type of the resource lock app type string type of the resource lock created at string output field lock created at lock created by object output field lock created by lock created by id string unique identifier lock created by type string type of the resource lock created by login string output field lock created by login lock created by name string name of the resource lock expired at string output field lock expired at lock is download prevented boolean output field lock is download prevented id string unique identifier type string type of the resource allowed invitee roles array output field allowed invitee roles token type string type of the resource url string url endpoint for the request output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "12345","type" "file","allowed invitee roles" \["editor"],"token type" "bearer","url" "https //cloud app box com/preview/expiring embed/ "},"has collaborations"\ true,"is accessible via shared link"\ true,"is externally owned"\ true,"is package"\ true,"item status" "active","lock" {"id" "11446498","type" "lock","app type" "office wopiplus","created at" "2012 12 12t10 53 43 08 00","created by" {"id" "11446498","type" "user","lo get file from shared link retrieves a file from box using a shared link, requiring specific headers for authorization endpoint url /shared items method get input argument name type required description parameters fields array optional parameters for the get file from shared link action parameters fields id string optional parameters for the get file from shared link action parameters fields type string optional parameters for the get file from shared link action parameters fields name string optional parameters for the get file from shared link action headers object required http headers for the request headers boxapi string required http headers for the request headers if none match string optional http headers for the request input example {"parameters" {"fields" \[{"id" "11446498","type" "file","name" "aaron levie"}]},"headers" {"boxapi" "shared link=\[link]\&shared link password=\[password]","if none match" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource allowed invitee roles array output field allowed invitee roles purged at string output field purged at representations object output field representations representations entries array output field representations entries representations entries content object response content representations entries content url template string url endpoint for the request representations entries info object output field representations entries info representations entries info url string url endpoint for the request representations entries properties object output field representations entries properties representations entries properties dimensions string output field representations entries properties dimensions representations entries properties paged boolean output field representations entries properties paged representations entries properties thumb boolean output field representations entries properties thumb representations entries representation string output field representations entries representation representations entries status object status value representations entries status state string status value output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "12345","type" "file","allowed invitee roles" \["editor"],"purged at" "2012 12 12t10 53 43 08 00","representations" {"entries" \[]}}} get folder for shared link retrieve the folder associated with a provided shared link in box, requiring specific headers for authentication endpoint url /shared items method get input argument name type required description parameters fields array optional parameters for the get folder for shared link action parameters fields id string optional parameters for the get folder for shared link action parameters fields type string optional parameters for the get folder for shared link action parameters fields name string optional parameters for the get folder for shared link action headers object required http headers for the request headers boxapi string required http headers for the request headers if none match string optional http headers for the request input example {"parameters" {"fields" \[{"id" "11446498","type" "folder","name" "top secret"}]},"headers" {"boxapi" "shared link=\[link]\&shared link password=\[password]","if none match" "1"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource allowed invitee roles array output field allowed invitee roles allowed shared link access levels array output field allowed shared link access levels name string name of the resource owned by object output field owned by owned by id string unique identifier owned by type string type of the resource owned by login string output field owned by login owned by name string name of the resource output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "12345","type" "folder","allowed invitee roles" \["editor"],"allowed shared link access levels" \["open"],"name" "contracts","owned by" {"id" "11446498","type" "user","login" "ceo\@example com","name" "aaron levie"}}} get group retrieves details for a specified group in box, accessible by group members or admin level users endpoint url /groups/{{group id}} method get input argument name type required description path parameters group id string required parameters for the get group action parameters fields array optional parameters for the get group action parameters fields id string optional parameters for the get group action parameters fields type string optional parameters for the get group action parameters fields name string optional parameters for the get group action input example {"parameters" {"fields" \[{"id" "11446498","type" "group","name" "aaron levie"}]},"path parameters" {"group id" "57645"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource created at string output field created at description string output field description external sync identifier string unique identifier group type string type of the resource invitability level string output field invitability level member viewability level string output field member viewability level modified at string output field modified at name string name of the resource permissions object output field permissions permissions can invite as collaborator boolean output field permissions can invite as collaborator provenance string output field provenance output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "11446498","type" "group","created at" "2012 12 12t10 53 43 08 00","description" "support group as imported from active directory","external sync identifier" "ad 123456","group type" "managed group","invitability level" "admins only","member viewability level" "admins only","modified at" "2012 12 12t10 53 43 08 00","name" "support","permissions" {"can invite as collaborator"\ true},"provenance" "active directory"}} get list items in folder retrieves a list of items within a specified folder on box, including files, folders, and web links, identified by the folder id endpoint url /folders/{{folder id}}/items method get input argument name type required description path parameters folder id string required parameters for the get list items in folder action parameters direction string optional parameters for the get list items in folder action parameters limit number optional parameters for the get list items in folder action parameters marker string optional parameters for the get list items in folder action parameters offset number optional parameters for the get list items in folder action parameters sort string optional parameters for the get list items in folder action parameters usemarker boolean optional parameters for the get list items in folder action parameters fields array optional parameters for the get list items in folder action parameters fields id string optional parameters for the get list items in folder action parameters fields type string optional parameters for the get list items in folder action parameters fields name string optional parameters for the get list items in folder action headers object optional http headers for the request headers boxapi string optional http headers for the request input example {"parameters" {"direction" "asc","limit" 100,"marker" "jv9irgzmieibasejog9ydcrngd2ymozibjsxbjmjis3kiovii","offset" 0,"sort" "0","usemarker"\ false,"fields" \[{"id" "11446498","type" "user","name" "aaron levie"}]},"path parameters" {"folder id" "123456"},"headers" {"boxapi" "shared link=\[link]\&shared link password=\[password]"}} output parameter type description status code number http status code of the response reason string response reason phrase limit number output field limit offset number output field offset order array output field order order by string output field order by order direction string output field order direction total count number count value output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"limit" 1000,"offset" 2000,"order" \[{}],"total count" 5000}} get list parts retrieve a list of uploaded file chunks for a given upload session in box using the specified upload session id endpoint url /files/upload sessions/{{upload session id}}/parts method get input argument name type required description path parameters upload session id string required parameters for the get list parts action parameters limit number optional parameters for the get list parts action parameters offset number optional parameters for the get list parts action input example {"parameters" {"limit" 100,"offset" 0},"path parameters" {"upload session id" "d5e3f7a"}} output parameter type description status code number http status code of the response reason string response reason phrase entries array output field entries entries part id string unique identifier entries offset number output field entries offset entries size number output field entries size entries sha1 string output field entries sha1 limit number output field limit offset number output field offset order array output field order order by string output field order by order direction string output field order direction total count number count value output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"entries" \[{}],"limit" 1000,"offset" 2000,"order" \[{}],"total count" 5000}} get metadata query retrieves metadata query indices in box for a specified scope and template key, requiring 'scope' and 'template key' parameters endpoint url /metadata query indices method get input argument name type required description parameters scope string required parameters for the get metadata query action parameters template key string required parameters for the get metadata query action input example {"parameters" {"scope" "global","template key" "properties"}} output parameter type description status code number http status code of the response reason string response reason phrase entries array output field entries entries id string unique identifier entries type string type of the resource entries status string status value entries fields array output field entries fields entries fields key string output field entries fields key entries fields sort direction string output field entries fields sort direction limit number output field limit next marker string output field next marker output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"entries" \[{}],"limit" 100,"next marker" "0! m7487opvfbtnbv xsqju50gqflbffu5narmwd7ck61gh qo40m1s2xn5zwzpbzejaqs1sojjiqoo5 "}} get upload session retrieve details of a specific upload session in box using the provided upload session id endpoint url /files/upload sessions/{{upload session id}} method get input argument name type required description path parameters upload session id string required parameters for the get upload session action input example {"path parameters" {"upload session id" "d5e3f7a"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource num parts processed number output field num parts processed part size number output field part size session endpoints object output field session endpoints session endpoints abort string output field session endpoints abort session endpoints commit string output field session endpoints commit session endpoints list parts string output field session endpoints list parts session endpoints log event string output field session endpoints log event session endpoints status string status value session endpoints upload part string output field session endpoints upload part session expires at string output field session expires at total parts number output field total parts output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "f971964745a5cd0c001bbe4e58196bfd","type" "upload session","num parts processed" 455,"part size" 1024,"session endpoints" {"abort" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","commit" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","list parts" "https //upload box com/api/2 0/files/upload sessions/f971964745a5cd0c001bbe4e581 ","log event" "htt get user retrieves detailed information about a specified user in the box enterprise environment using their user id endpoint url /users/{{user id}} method get input argument name type required description path parameters user id string required parameters for the get user action parameters fields array optional parameters for the get user action parameters fields id string optional parameters for the get user action parameters fields type string optional parameters for the get user action parameters fields name string optional parameters for the get user action input example {"parameters" {"fields" \[{"id" "11446498","type" "user","name" "aaron levie"}]},"path parameters" {"user id" "12345"}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier type string type of the resource address string output field address avatar url string url endpoint for the request can see managed users boolean output field can see managed users created at string output field created at enterprise object output field enterprise enterprise id string unique identifier enterprise type string type of the resource enterprise name string name of the resource external app user id string unique identifier hostname string name of the resource is exempt from device limits boolean output field is exempt from device limits is exempt from login verification boolean output field is exempt from login verification is external collab restricted boolean output field is external collab restricted is platform access only boolean output field is platform access only is sync enabled boolean output field is sync enabled job title string output field job title language string output field language login string output field login max upload size number output field max upload size modified at string output field modified at my tags array output field my tags output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"id" "11446498","type" "user","address" "900 jefferson ave, redwood city, ca 94063","avatar url" "https //www box com/api/avatar/large/181216415","can see managed users"\ true,"created at" "2012 12 12t10 53 43 08 00","enterprise" {"id" "11446498","type" "enterprise","name" "acme inc "},"external app user id" "my user 1234","hostname" "https //example app box com/","is exempt from device limits"\ true,"is exempt from login verifica get workflows retrieves a list of manual start workflows associated with a specified folder id in box endpoint url /workflows method get input argument name type required description parameters folder id string required parameters for the get workflows action parameters limit number optional parameters for the get workflows action parameters marker string optional parameters for the get workflows action parameters trigger type string optional parameters for the get workflows action input example {"parameters" {"folder id" "123456","limit" 100,"marker" "jv9irgzmieibasejog9ydcrngd2ymozibjsxbjmjis3kiovii","trigger type" "workflow manual start"}} output parameter type description status code number http status code of the response reason string response reason phrase entries array output field entries entries id string unique identifier entries type string type of the resource entries name string name of the resource entries description string output field entries description entries is enabled boolean output field entries is enabled entries flows array output field entries flows entries flows id string unique identifier entries flows type string type of the resource entries flows trigger object output field entries flows trigger entries flows trigger type string type of the resource entries flows trigger trigger type string type of the resource entries flows trigger scope array output field entries flows trigger scope entries flows trigger scope type string type of the resource entries flows trigger scope ref string output field entries flows trigger scope ref entries flows trigger scope object object output field entries flows trigger scope object entries flows outcomes array output field entries flows outcomes entries flows outcomes id string unique identifier entries flows outcomes type string type of the resource entries flows outcomes name string name of the resource entries flows outcomes action type string type of the resource entries flows outcomes if rejected array output field entries flows outcomes if rejected entries flows outcomes if rejected id string unique identifier output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"entries" \[{}],"limit" 1000,"next marker" "jv9irgzmieibasejog9ydcrngd2ymozibjsxbjmjis3kiovii","prev marker" "jv9irgzmieibasejog9ydcrngd2ymozibjsxbjmjis3kiovih"}} remove upload session aborts an ongoing box upload session and discards all associated data using the specified upload session id endpoint url /files/upload sessions/{{upload session id}} method delete input argument name type required description path parameters upload session id string required parameters for the remove upload session action input example {"path parameters" {"upload session id" "d5e3f7a"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"reason" "ok","response headers" {},"json body" {}} upload file uploads a small file to box using provided data body, form data, and headers endpoint url /files/content method post input argument name type required description parameters fields array optional parameters for the upload file action parameters fields id string optional parameters for the upload file action parameters fields type string optional parameters for the upload file action parameters fields name string optional parameters for the upload file action data body object required response data data body attributes object required response data data body attributes content created at string required response data data body attributes content modified at string required response data data body attributes name string required response data data body attributes parent object optional response data data body attributes parent id string required response data form data object required response data form data files array required response data form data files file name string required response data form data files file string required response data headers object required http headers for the request headers content md5 string optional http headers for the request input example {"parameters" {"fields" \[{"id" "11446498","type" "user","name" "aaron levie"}]},"data body" {"attributes" {"content created at" "2012 12 12t10 53 43 08 00","content modified at" "2012 12 12t10 53 43 08 00","name" "photo png","parent" {"id" "124132"}}},"form data" {"files" \[{"file" " /data/files/s png","file name" "s png"}]},"headers" {"content md5" "134b65991ed521fcfe4724b7d814ab8ded5185dc"}} output parameter type description status code number http status code of the response reason string response reason phrase entries array output field entries entries parent object output field entries parent entries parent id string unique identifier entries parent etag string output field entries parent etag entries parent type string type of the resource entries parent sequence id string unique identifier entries parent name string name of the resource entries tags array output field entries tags entries watermark info object output field entries watermark info entries watermark info is watermarked boolean output field entries watermark info is watermarked entries expires at string output field entries expires at entries representations object output field entries representations entries representations entries array output field entries representations entries entries representations entries content object response content entries representations entries content url template string url endpoint for the request entries representations entries info object output field entries representations entries info entries representations entries info url string url endpoint for the request entries representations entries properties object output field entries representations entries properties entries representations entries properties dimensions string output field entries representations entries properties dimensions entries representations entries properties paged boolean output field entries representations entries properties paged entries representations entries properties thumb boolean output field entries representations entries properties thumb entries representations entries representation string output field entries representations entries representation entries representations entries status object status value output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"entries" \[{}],"total count" 1}} upload part of file updates a specific chunk of a file during an upload session in box, requiring the upload session id endpoint url /files/upload sessions/{{upload session id}} method put input argument name type required description path parameters upload session id string required parameters for the upload part of file action headers object required http headers for the request headers content range string required http headers for the request headers digest string required http headers for the request input example {"path parameters" {"upload session id" "d5e3f7a"},"headers" {"content range" "bytes 8388608 16777215/445856194","digest" "sha=fpryg5evqletdzqekaflqwbxjzm="}} output parameter type description status code number http status code of the response reason string response reason phrase part object output field part part offset number output field part offset part part id string unique identifier part sha1 string output field part sha1 part size number output field part size output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"part" {"offset" 16777216,"part id" "6f2d3486","sha1" "134b65991ed521fcfe4724b7d814ab8ded5185dc","size" 3222784}}} response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt