Skip to content

Latest commit

 

History

History
306 lines (203 loc) · 6.05 KB

GET.md

File metadata and controls

306 lines (203 loc) · 6.05 KB

GET

These functions pull data from GlassFrog with GET HTTP requests.

General form:

All GET functions begin with the get function.

gf.get() ...

####### Optionally, if caching has been turned on, you may check the cache for a value before doing a fetch.

To do this, pass a true cache flag to the get function:

gf.get(true) ...

If caching is turned on all fetches will store a local copy.

If caching is NOT turned on, and a true cache flag is pass, an error will be thrown.

Circles

Get all circles with an ID of $ID:

gf.get().circles().withID($ID).then(...).catch(...);

Get all circles:

gf.get().circles().all().then(...).catch(...);

Roles

Get all roles with an ID of $ID:

gf.get().roles().withID($ID).then(...).catch(...);

Get all roles within some other type:

gf.get().roles().within() ...

Get all roles within circles with ID of $ID:

gf.get().roles().within().circles().withID($ID).then(...).catch(...);

Get all roles within people with ID of $ID:

gf.get().roles().within().people().withID($ID).then(...).catch(...);

Get all roles:

gf.get().roles().all().then(...).catch(...);

People

Get all people with ID of $ID:

gf.get().people().withID($ID).then(...).catch(...);

Get all people within some other type:

gf.get().people().within() ...

Get all people within circles with ID of $ID:

gf.get().people().within().circles().withID($ID).then(...).catch(...);

Get all people within roles with name of 'secretary':

gf.get().people().within().roles().withName('secretary').then(...).catch(...);

Get all people within roles with name of 'rep link' or 'rep_link':

gf.get().people().within().roles().withName('rep_link').then(...).catch(...);
gf.get().people().within().roles().withName('rep link').then(...).catch(...);

Get all people within roles with name of 'lead link' or 'lead_link':

gf.get().people().within().roles().withName('lead_link').then(...).catch(...);
gf.get().people().within().roles().withName('lead link').then(...).catch(...);

Get all people within roles with name of 'facilitator':

gf.get().people().within().roles().withName('facilitator').then(...).catch(...);

Get all people:

gf.get().people().all().then(...).catch(...);

Projects

Get all projects with ID of $ID:

gf.get().projects().withID($ID).then(...).catch(...);

Get all projects within some other type:

gf.get().projects().within() ...

Get all projects within circles with ID of $ID:

gf.get().projects().within().circles().withID($ID).then(...).catch(...);

Get all projects:

gf.get().projects().all().then(...).catch(...);

Metrics

Get all metrics with ID of $ID:

gf.get().metrics().withID($ID).then(...).catch(...);

Get all metrics within some other type:

gf.get().metrics().within() ...

Get all metrics within circles with ID of $ID including global metrics:

gf.get().metrics().within().circles().withID($ID).withGlobals().then(...).catch(...);

Get all metrics within circles with ID of $ID NOT including global metrics:

gf.get().metrics().within().circles().withID($ID).withoutGlobals().then(...).catch(...);

Get all global metrics:

gf.get().metrics().globals().then(...).catch(...);

Get all metrics:

gf.get().metrics().all().then(...).catch(...);

Checklist Items:

gf.get().checklistItems().then(...).catch(...);

Get all checklist items with ID of $ID:

gf.get().checklistItems().withID($ID).then(...).catch(...);

Get all checklist items with some other type:

gf.get().checklistItems().within() ...

Get all checklist items within circles with ID of $ID including global checklist items:

gf.get().checklistItems().within().circles().withID($ID).withGlobals().then(...).catch(...);

Get all checklist items within circles with ID of $ID NOT including global checklist items:

gf.get().checklistItems().within().circles().withID($ID).withoutGlobals().then(...).catch(...);

Get all global checklist items:

gf.get().checklistItems().globals().then(...).catch(...);

Get all checklist items:

gf.get().checklistItems().all().then(...).catch(...);

Actions

Get all actions with ID of $ID:

gf.get().actions().withID($ID).then(...).catch(...);

Get all actions within some other type:

gf.get().actions().within() ...

Get all actions within circles with ID of $ID:

gf.get().actions().within().circles().withID($ID).then(...).catch(...);

Get all actions within people with ID of $ID:

gf.get().actions().within().people().withID($ID).then(...).catch(...);

Get all actions created since date of $DATE:

gf.get().actions().createdSince($DATE).then(...).catch(...);

Get all actions:

gf.get().actions().all().then(...).catch(...);

Triggers

Get all triggers with ID of $ID:

gf.get().triggers().withID($ID).then(...).catch(...);

Get all triggers within some other type:

gf.get().triggers().within() ...

Get all triggers within circles with ID of $ID:

gf.get().triggers().within().circles().withID($ID).then(...).catch(...);

Get all triggers within people with ID of $ID:

gf.get().triggers().within().people().withID($ID).then(...).catch(...);

Get all triggers created since date of $DATE:

gf.get().triggers().createdSince($DATE).then(...).catch(...);

Get all triggers:

gf.get().triggers().all().then(...).catch(...);