Organization Export
0 min
{ "id" "g2iwhm7wkkj nexpql2mz", "type" "api oas v2", "data" { "method" "get", "url" " https //api archbee com/api/public api/team/export https //api archbee com/api/public api/team/export ", "servers" \[ { "url" " https //api archbee com/api/public api/team/export https //api archbee com/api/public api/team/export ", "description" "archbee api server" } ], "name" "organization export", "description" " export assets, spaces with documents, team and user data from archbee given teamid use \ output \<export file path> ", "contenttype" "application/json", "request" { "pathparameters" \[], "headerparameters" \[ { "kind" "required", "name" "content type", "type" "string", "example" "application/json", "description" "" } ], "queryparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "body", "type" "object", "description" "", "schema" \[ { "name" "teamid", "kind" "required", "type" "string", "description" "team id for which the export is computed ", "example" "21 character string0" }, { "name" "exportthisspaceonly", "kind" "optional", "type" "boolean", "description" "optional, use this if you want to export data only from the space with docspaceid ", "example" true }, { "name" "exportaslink", "kind" "optional", "type" "boolean", "description" "optional, use this if you want to get a link to the zip archive ", "example" true } ], "isexpanded" true } ], "formdataparameters" \[], "oauthparameters" \[ { "id" "bearerauth", "name" "bearerauth", "kind" "optional", "type" "http", "description" " requires the authorization header in the form authorization bearer {base64(docspaceid apikey)} where the token is base64 encoding of docspaceid, tilde, and apikey ", "scheme" "bearer" } ] }, "responses" \[ { "statuscode" "200", "description" "successful export", "jsonexample" "", "isexpanded" true }, { "statuscode" "400", "description" "invalid request", "jsonexample" "", "isexpanded" true, "schema" \[ { "kind" "optional", "type" "object", "description" "", "customtype" "response400", "schema" \[ { "name" "status", "kind" "optional", "type" "string\<ok | not ok>", "description" "response status", "example" "not ok" }, { "name" "messages", "kind" "optional", "type" "array", "description" "array of messages", "example" "\["some error message"]", "itemtype" "string", "customtype" "string\[]", "itemexample" "some error message", "itemdefault" "" } ], "modelref" "#/components/schemas/response400", "isexpanded" true } ] } ], "hasxcodesamples" false, "examples" { "languages" \[ { "id" " 66l5yozzzffcp0kl6rsc", "language" "curl", "label" "curl", "code" "curl request get \\\n url https //api archbee com/api/public api/team/export https //api archbee com/api/public api/team/export \\\n header 'accept application/json' \\\n header 'content type application/json' \\\n data '{\n "teamid" "21 character string0"\n }'" }, { "id" "69yfo7t7v4qasim6zip8v", "language" "javascript", "label" "javascript", "code" "var myheaders = new headers();\nmyheaders append("accept", "application/json");\nmyheaders append("content type", "application/json");\n\nvar raw = json stringify({\n "teamid" "21 character string0"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(" https //api archbee com/api/public api/team/export https //api archbee com/api/public api/team/export ", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));" }, { "id" "jprtjmctvdy o7vczoyqu", "language" "ruby", "label" "ruby", "code" "require "uri"\nrequire "json"\nrequire "net/http"\n\nurl = uri(" https //api archbee com/api/public api/team/export")\n\nhttps https //api archbee com/api/public api/team/export")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\["accept"] = "application/json"\nrequest\["content type"] = "application/json"\nrequest body = json dump({\n "teamid" "21 character string0"\n})\n\nresponse = https request(request)\nputs response read body\n" }, { "id" "kavxmrc22ctqsptz8diwa", "language" "python", "label" "python", "code" "import requests\nimport json\n\nurl = " https //api archbee com/api/public api/team/export"\n\npayload https //api archbee com/api/public api/team/export"\n\npayload = json dumps({\n "teamid" "21 character string0"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request("get", url, headers=headers, data=payload)\n\nprint(response text)\n" } ], "selectedlanguageid" " 66l5yozzzffcp0kl6rsc" }, "results" { "languages" \[ { "id" "tzitw9fzmdf x5vegsjoe", "language" "200", "code" "// successful export\n" }, { "id" "cqy 1ke6o2weyne3ozogz", "language" "400", "code" "// invalid request\n{\n "status" "not ok",\n "messages" \[\n "some error message"\n ]\n}" } ], "selectedlanguageid" "tzitw9fzmdf x5vegsjoe" } }, "children" \[ { "text" "" } ] }