Content Comparison

...

• https://<domain-app>.api.columbia.edu/{v}/{resources}

Version should be kept to the right of the app name. We choose to prefix 'v' as part of version and use only the ordinal numbers, like “v1”, “v2”, etc.

...

• 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 for resource(s) in collection

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

...

• GET https://<domain-app>.api.columbia.edu/{v}/console: API console (MuleSoft APIkit).

• GET https://<domain-app>.api.columbia.edu/{v}/resourceTypes: An endpoint used to discover the types of resources used by this app.

• GET https://<domain-app>.api.columbia.edu/{v}/types: (schemas) Introspect resource and attribute definitions.

Enterprise Metadata Resources (DRAFT)

A top-level Columbia University enterprise metadata directory will contain the list of available types (schemas) and resource types (item, collection, etc.) that are used by the various applications:

• GET https://<domain-app>.api.columbia.edu/v1/resourceTypes

• GET https://<domain-app>.api.columbia.edu/v1/types

...