{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:id/assets/:name","auth":"never","results":{"codes":[{"name":"keyValue","code":"{\n    \"name\": \"$company_branding\",\n    \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n    \"type\": \"keyValue\",\n    \"value\": {\n        \"accentColor\": \"#12c480\",\n        \"titleForegroundColor\": \"#ffffff\",\n        \"companyName\": \"Droplit\"\n    }\n}","language":"json","status":200},{"code":"THE_REQUESTED_ASSET","language":"json","name":"Binary","status":200},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}","language":"json","name":"Invalid Ecosystem","status":400},{"code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"query\",\n            \"message\": \"field must be one of the following values: master, custom, default\",\n            \"path\": \"source\"\n        }\n    ]\n}","language":"json","name":"Invalid Source","status":404},{"code":"Asset with id $fake_asset_name does not exist.","language":"text","name":"Name Not Found","status":404},{"status":404,"name":"Ecosystem Not Found","language":"text","code":"Ecosystem with id C59b343ae7cabfb88227aa196 does not exist."}]},"settings":"59a75ffc4836990031f5ec2f","params":[{"name":"id","type":"string","default":"","desc":"The ID of the ecosystem.","required":true,"in":"path","ref":"","_id":"5b2d6b9e0bbfa50003ae7a6c"},{"name":"name","type":"string","default":"","desc":"The name of the asset to be retrieved.","required":true,"in":"path","ref":"","_id":"5b2d6b9e0bbfa50003ae7a6b"},{"name":"source","type":"string","default":"","desc":"The group from which the asset is being requested. The groups are \"master\", \"custom\", and \"default\".","required":false,"in":"query","ref":"","_id":"5b2d6b9e0bbfa50003ae7a6a"},{"name":"authorization","type":"string","default":"","desc":"The user's authorization token.","required":true,"in":"header","ref":"","_id":"5b686968d301b30003b0a4d3"}],"examples":{"codes":[{"name":"keyValue Asset","language":"http","code":"GET https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/assets/$company_branding?source=default HTTP/1.1\nauthorization: AUTH_TOKEN"},{"name":"Binary Asset","language":"http","code":"GET https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/assets/$logo_foreground_square?source=master HTTP/1.1\nauthorization: AUTH_TOKEN"},{"language":"javascript","code":"droplit.assets.getFile(\"C5aebfea1278b9bfe02639d21\", \"$logo_foreground_square\");"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Get an Asset","type":"endpoint","slug":"get-an-asset","excerpt":"Get a specific asset accessible by an ecosystem.","body":"Retrieve an asset that an ecosystem can access.\n\n# Sources\n\nAn asset whose source is _master_ contains only the properties originally provided to it by the Droplit system, while an asset whose source is _custom_ only contains user-created properties. An asset that contains both Droplit-assigned and user-created properties has a source of _default_, or merged.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b2d69121235f1000317757b","project":"568bdc1483d2061900d86cdc","version":{"version":"0","version_clean":"0.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255","59f76fef8581dc0010593e6f","5a0c003680a35b0012c35db0","5a8358722e78660075e45f42","5a846645b5ec3a001203517e","5b258091bc7a6700033b9cb5","5b26e48e024807000315a740","5b44edff3306680003663f5c","5b468abd3d4a9e0003789111","5b468d8f3dcb6a0003c6e374","5b47b0b93d4a9e000378a33a","5b538d114ea24f00033c726f","5b6a0efe402b32000336c33f","5bba5e5d7ba7710003bd902a","5bc2703349ac3a0013eec3e5","5c351061191e2b002b4988a8","5c8b01b199b56e00440aa018"],"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","__v":35},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Assets API","slug":"assets-api","order":14,"from_sync":false,"reference":false,"_id":"5b6a0efe402b32000336c33f","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","createdAt":"2018-08-07T21:28:30.258Z","__v":0},"user":"5a6a26281895510045b2cd40","createdAt":"2018-06-22T21:24:34.642Z","githubsync":"","__v":11,"parentDoc":null}

getGet an Asset

Get a specific asset accessible by an ecosystem.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the ecosystem.
name:
required
string
The name of the asset to be retrieved.

Query Params

source:
string
The group from which the asset is being requested. The groups are "master", "custom", and "default".

Headers

authorization:
required
string
The user's authorization token.

Examples


Result Format


Documentation

Retrieve an asset that an ecosystem can access. # Sources An asset whose source is _master_ contains only the properties originally provided to it by the Droplit system, while an asset whose source is _custom_ only contains user-created properties. An asset that contains both Droplit-assigned and user-created properties has a source of _default_, or merged.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}