CaseMap Server

<resourceID>

<resourceID>

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

<resourceID>

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!  

 

Description

Uniquely identifies a resource within a service. The <resource ID> contains all the information that is needed by the service to discover the resource type and scoping, as well as the resource itself.

 

Syntax

<ServerResource>/[<service>/[<type>/[<resource ID>]]]

 

Remarks

The <resource ID> has the following structure:

{<type name>-<instance identifier>}

The <type name> is the singular form of the resource type that is not qualified by the service name. For example, if the resource type is specified by "/CMServerAD/cases", the <type name> is "case".
The <instance identifier> is the unique identifier of the resource within the resource scoping. The <instance identifier> is in general a UUID, but may be something else (such as a friendly name or integer) in the case of legacy data.

 

Supported Methods and Examples

The following sections describe the <resource ID> naming convention for each type, as well as associated examples for each.

 

Universal Identifier (Uid)

Description

caseID

Identifies a case.

Syntax: case-{integer}

Comments: CaseMap assigns each case a unique number upon creation. The integer is an increase from the previous created case. You can retrieve the caseID from GET get-cases.

Example: http://localhost/CaseMapAD/CMServerAD.svc/cases/case-6/views/?userId=3

 

userID

Identifies a user.

Syntax: userId-{integer}

Comments: CaseMap assigns each user a unique number upon creation. The integer is an increase from the previous created user. You can retrieve the userID values with GET get-case-users.

Example: http://localhost/CaseMapAD/CMServerAD.svc/cases/case-6/views/?userId=3