CaseMap Server

About URI Structure

About URI Structure

Previous topic Next topic No directory for this topic No expanding text in this topic  

About URI Structure

Previous topic Next topic Topic directory requires JavaScript JavaScript is required for expanding text JavaScript is required for the print function Mail us feedback on this topic!  

The CaseMap Server API is structured around making REST calls to resources stored on a server. The location of CaseMap Server resources are declared using a URI, which adheres to the following pattern:

 

Resource Content:

<ServerResource>/[<service>/[<type>/[<resource ID>]]][?<query>][#<fragment>]

 

The following table describes the elements of a CaseMap Server URI:

 

Element

Description

/ (Root)

Lists available services; the root also contains the properties of the service host.

Example: http://localhost/CaseMapAD/

 

<service>

Uniquely identifies a service on a service host.

Example: http://localhost/CaseMapAD/CMServerAD.svc/

 

<type>

Uniquely identifies the target resource type within a service.

Example: http://localhost/CaseMapAD/CMServerAD.svc/cases/

 

<resourceID>

The GUID of the resource.

Example: http://localhost/CaseMapAD/CMServerAD.svc/cases/case-6/data

 

? <query>

Optional constraint used to filter or narrow the selection of a resource or a collection of resources.

Example: http://localhost/CaseMapAD/CMServerAD.svc/cases/case-6/data/facts/?recordCount=5&startingRecordNumber=5