Projecten en deployments opvragen
Elke workspace van een account, en dan elke app die echt draait, als twee leesaanroepen op een CouchDB-view.
"Projecten" en "deployments" beantwoorden twee verschillende vragen. Een project is een workspace op
het account, wat je zou zien in de projectwisselaar, of er nu ooit iets in live is gegaan of niet. Een
deployment is één app die echt ergens draait, is_deployment: true op zijn eigen document. Een
account opvragen betekent meestal allebei: eerst de workspaces, dan wat er in elk daarvan draait.
Methoden
Get Account Projects
Returns the projects owned by the account (or all projects for superuser and support accounts) from the user_projects master view.
Get Account Deployments
Returns the deployments associated with the account from the user_deployments master view.
Stappenplan
Vraag de projecten van het account op
Geen velden behalve je sleutel: beide methoden halen de CouchDB-view op met de uid waarnaar je inloggegevens al verwijzen.
2. Vraag op wat echt gedeployd is
Dezelfde vorm, een andere view: user_deployments geeft alleen een document als is_deployment
waar is, dus deze lijst is een deelverzameling van alle apps die het account ooit heeft gemaakt: die
met een live toegangs-URL.
Het antwoord
Beide methoden geven een CouchDB-viewresultaat rechtstreeks door, zonder omhulling: code is 871
(de vaste succescode die get_couch_view altijd teruggeeft, niet de gebruikelijke 1), en data is
het ruwe nano-viewantwoord: total_rows, offset en een array rows met { id, key, value }. id
is de _id van het project (of de deployment), de waarde die je als app_id meegeeft aan elke andere
aanroep in deze sectie.
Rijen van get_account_deployments hebben dezelfde velden plus app_hosting_server,
app_datacenter_id, app_hosting en is_deployment: true, omdat user_deployments die erbovenop
geeft. app_status_code < 4 is de enige status die deze view of user_projects je ooit laat zien:
beide mapfuncties filteren alles op 4 of hoger weg, dus een verwijderd project verdwijnt gewoon in
plaats van te verschijnen met een status om te controleren.
get_account_projects zet main_profile_name op de rij van de eigen workspace van het account als
die workspace een benoemd profiel heeft, dus de rij die je als "jouw" project toont kan anders
heten dan de opgeslagen app_name. Geef de voorkeur aan main_profile_name als die er is.
Fouten
Beide methoden falen alleen op de manier waarop elke aanroep kan falen: een ontbrekende of niet
toegestane api_key (-401, zie Errors). Geen van beide kijkt naar app_id of een
andere input, omdat ze er geen hebben. Een lege array rows is een echt, geslaagd antwoord voor een
account dat nog niets in die lijst heeft, geen fout.