Content Comparison

...

• GET https://<domain-app>.api.columbia.edu/{v}/{resources} - Retrieves a list of resources

• GET https://<domain-app>.api.columbia.edu/{v}/{resources}/{id} - Retrieves a specific resource

• POST https://<domain-app>.api.columbia.edu/{v}/{resources} - Creates a new resource using JSON payload

• PUT https://<domain-app>.api.columbia.edu/{v}/{resources}/{id} - Updates resource info

• PATCH https://<domain-app>.api.columbia.edu/{v}/{resources}/{id} - Partially updates the resource

• DELETE https://<domain-app>.api.columbia.edu/{v}/{resources}/{id} - Deletes the resource

• Search GET https://<domain-app>.api.columbia.edu/{v}/{resources}?filter=[{”{attribute1}”,”{op1}”,”{value1}”},…,{”{attribute2}”,”{op2}”,”{value2}”}]&sortBy={attribute}&sortOrder={asc|desc} [search]={keyword}&sort={attribute} - Search for resource(s) in collection

• Fields Sparse Fieldsets List GET https://<domain-app>.api.columbia.edu/{app}/{v}/{resources}?fields={“field1”,”field2”[{resource}]=field1,field2,…,”fieldN”}fieldN

Note that the above definitions have reserved use the following query parameter names:

• filter

• sortBy

• sortOrdersort

• fields

Please use these as shown in the example. Additional query parameters can of course be usedFor more complete details, see the JSON API Architecture Pattern.

API Pattern Example

Basic Operation APIs are shown with examples (for the directory app, version 1):

...