Posted Jul 07 by Pete Oliver.
Updated Jul 07.

This is a listing of available REST API's for Leap Case.

Last activity Jul 07 by Pete Oliver.
555 views. 0 comments.

Auth

Authenticate Users

POST /oauth/clients
Create or Register a Client

GET /oauth/clients/:clientid
Retrieve a Client

PUT /oauth/clients/:clientid
Update a Client

DELETE /oauth/clients/:clientid
Delete a Client

GET /oauth/authorize?client_id={id}&redirect_uri={redirect_uri}&state={state}&scope=write&response_type=code
Authenticate and redirect

POST /oauth/token
Authenticate and obtain auth token

POST /oauth/check_token
Verify an authentication token

Case-templates

Manage Case Templates

GET /case-templates?page=1&items-per-page=20
List Case Template

GET /case-templates/:templateid
Get Case Template

Case-instances

Manage Cases

POST /case-instances/model/:instanceid?sendNotification=true
Create Case Instance

GET /case-instances?root-phase=active&case-status=all&include-counters=true&page=1&items-per-page=20
List Case Instances

GET /case-instances/model/:instanceid?root-phase=active&case-status=all&filter=iscustomer%253Dtrue&include-counters=true&page=1&items-per-page=20
LIST Case Instance of A Specific Template

GET /case-instances/:instanceid
Get a specific Case Instance

GET /case-instances/:instanceid/media
Download Case Instance as a Zip

GET /case-instances/:instanceid/case-roles/borrower/members?page=1&items-per-page=20
Get Case Members by Role

POST /case-instances/:instanceid/case-roles/borrower/modifymembers?sendNotification=false
Modify Case Members by Role

PUT /case-instances/:instanceid
Update a Case Instance

DELETE /case-instances/:instanceid?recursive=true
Delete a Case Instance

GET /case-instances/:instanceid/portfolios?page=1&items-per-page=20
List Portfolios

Portfolios

Manage Portfolios

GET /portfolios/:portfolioid
Get Portfolio

DELETE /portfolios/:portfolioid?recursive=true
Delete a Portfolio

GET /portfolios/:portfolioid/folios?page=1&items-per-page=20
List Folios

Folios

Manage Folios

GET /folios/:folioid
Get a Folio

POST /portfolios/:portfolioid/folios
Create a Folio

DELETE /folios/:folioid?recursive=true
Delete a Folio

POST /folios/:folioid/comments
Create a Comment

GET /folios/:folioid/comments
List Comments

POST /phases/:phaseid/submit?sendNotification=true
Transition a Phase of the Folio

GET /folios/:folioid/documents?page=1&items-per-page=20
List Documents

Documents

Manage Documents

GET /documents/:documentid
Get a Document

POST /folios/:folioid/documents
Create Document

POST /documents/:documentid
Delete a document

GET /documents/:documentid/versions?page=1&items-per-page=20&inline=true
List Document Versions

POST /documents/:documentid/versions?version-policy=next-major
Create a New Version of the document


Table of Contents