The Home Document is an entry point to the Core Capture Services.
GET {{baseUrl}}/?suppress_response_codes=in adipisicing
The Home Document is an entry point to the Core Capture Services. It is available to any caller. Its main purposes it to provide discovery of the URIs necessary to interact with the service. It is retrieved by performing an HTTP GET on the base installation path. So for example if the REST service was installed into https://{host}/cp-rest/v2, then performing a GET on this URI would return the Home Document. Its main purposes is to provide discovery of the URIs necessary to interact with the service. All clients must start from the Home Document and follow the hrefs given in the link relations to the resources desired. This is important to ensure that your client applications will always work regardless of the URI changes that may take place under different deployment configurations of the service.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
suppress_response_codes | string | This can be left without an assignment or you can use itself, suppress_response_codes=suppress_response_codes |
RESPONSES
status: OK
{"_links":{"urn:eim:linkrel:session":{"href":"https://{host}/cp-rest/v2/session"},"urn:eim:linkrel:tables":{"href":"https://{host}/cp-rest/v2/session/tables"},"urn:eim:linkrel:data-batches":{"href":"https://{host}/cp-rest/v2/session/batches"},"urn:eim:linkrel:files":{"href":"https://{host}/cp-rest/v2/session/files"},"urn:eim:linkrel:services":{"href":"https://{host}/cp-rest/v2/session/services"},"urn:eim:linkrel:doctypes":{"href":"https://{host}/cp-rest/v2/session/doctypes"},"oauth2-token":{"href":"https://{auth-host}/oauth/token"},"oauth2-authorize":{"href":"https://{auth-host}/oauth/authorize"},"about":{"href":"https://{host}/cp-rest/v2/about"}}}