Navigating Vuforia Studio > Projects and Experiences > Template-based Experiences > IRS Mappings > GET /id-resolution/mappings
  
GET /id-resolution/mappings
Request Parameters
Name
Required?
Data Type
Parameter Type
Description
id
No
Integer
Path
The ID of the mapping to be retrieved. If this is specified then all query string parameters are ignored.
key
No
String
Query String
Only mappings whose key matches the specified key will be returned. This can be used in combination with the value parameter.
value
No
String
Query String
Only mappings whose value matches the specified key will be returned. This can be used in combination with the key parameter.
Response Status Codes
Code
Description
200
The query completed successfully. The response conforms to the IRS mapping schema.
401
The required credentials are missing or incorrect.
403
The user does not have permission to view the mappings.
406
The Accept header was not present and not equal to application/json.
500
An internal server error occurred.
Request Body
The body of the request is a JSON object that conforms to theMapping JSON Schema and defines the mapping that should be created.
Examples
Query mappings by ID:
curl -u user:password https://es.example.com/ExperienceService/id-resolution/mappings/1592
Query mappings by Key:
curl -u user:password https://es.example.com/ExperienceService/id-resolution/mappings?key=urn:vuforia:vumark:2:101
Query mappings by Value:
curl -u user:password https://es.example.com/ExperienceService/id-resolution/mappings?value=urn:thingworx:thing:M100-101
Query mappings by Key and Value:
curl -u user:password https://es.example.com/ExperienceService/id-resolution/mappings?key=urn:vuforia:vumark:2:101&value=urn:thingworx:thing:M100-101