{"_id":"5b2d69121235f1000317757b","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":31,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"5b6a0efe402b32000336c33f","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-08-07T21:28:30.258Z","from_sync":false,"order":14,"slug":"assets-api","title":"Assets API"},"user":"5a6a26281895510045b2cd40","githubsync":"","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-06-22T21:24:34.642Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"name\": \"$company_branding\",\n    \"ecosystemId\": \"C5aebfea1278b9bfe02639d21\",\n    \"type\": \"keyValue\",\n    \"value\": {\n        \"accentColor\": \"#12c480\",\n        \"titleForegroundColor\": \"#ffffff\",\n        \"companyName\": \"Droplit\"\n    }\n}","name":"keyValue"},{"status":200,"name":"Binary","language":"json","code":"THE_REQUESTED_ASSET"},{"status":400,"name":"Invalid Ecosystem","language":"json","code":"{\n    \"errorType\": \"InvalidParams\",\n    \"errors\": [\n        {\n            \"in\": \"path\",\n            \"message\": \"invalid id\",\n            \"path\": \"id\"\n        }\n    ]\n}"},{"status":404,"name":"Invalid Source","language":"json","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}"},{"status":404,"name":"Name Not Found","language":"text","code":"Asset with id $fake_asset_name does not exist."},{"code":"Ecosystem with id C59b343ae7cabfb88227aa196 does not exist.","language":"text","name":"Ecosystem Not Found","status":404}]},"settings":"59a75ffc4836990031f5ec2f","examples":{"codes":[{"code":"GET https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/assets/$company_branding?source=default HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http","name":"keyValue Asset"},{"code":"GET https://ioe.droplit.io/api/ecosystems/C5aebfea1278b9bfe02639d21/assets/$logo_foreground_square?source=master HTTP/1.1\nauthorization: AUTH_TOKEN","language":"http","name":"Binary Asset"},{"code":"droplit.assets.getFile(\"C5aebfea1278b9bfe02639d21\", \"$logo_foreground_square\");","language":"javascript"}]},"method":"get","auth":"never","params":[{"_id":"5b2d6b9e0bbfa50003ae7a6c","ref":"","in":"path","required":true,"desc":"The ID of the ecosystem.","default":"","type":"string","name":"id"},{"_id":"5b2d6b9e0bbfa50003ae7a6b","ref":"","in":"path","required":true,"desc":"The name of the asset to be retrieved.","default":"","type":"string","name":"name"},{"_id":"5b2d6b9e0bbfa50003ae7a6a","ref":"","in":"query","required":false,"desc":"The group from which the asset is being requested. The groups are \"master\", \"custom\", and \"default\".","default":"","type":"string","name":"source"},{"_id":"5b686968d301b30003b0a4d3","ref":"","in":"header","required":true,"desc":"The user's authorization token.","default":"","type":"string","name":"authorization"}],"url":"/:id/assets/:name"},"isReference":false,"order":1,"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.","excerpt":"Get a specific asset accessible by an ecosystem.","slug":"get-an-asset","type":"endpoint","title":"Get an Asset"}

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 }}