Use to retrieve a record by their product ID and ID extension.
curl -X get "http://hostname:8080/eml/rest/records/{repositoryName}/{id}?idExt=&workItemId=&includeSystemAttributes=&findRootRecord=&recordState=&active=&perspectiveName=&relationshipType=&relationshipDepth="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;
import java.io.File;
import java.util.*;
public class RecordsApiExample {
public static void main(String[] args) {
RecordsApi apiInstance = new RecordsApi();
String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
String id = id_example; // String | Record Id
String idExt = idExt_example; // String | Record Id Extension
String authorization = authorization_example; // String | Authorization String
String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
String workItemId = workItemId_example; // String | Work Item ID
Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
Boolean findRootRecord = true; // Boolean | Finds root record only- Default false
String recordState = recordState_example; // String | Record State- CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
String active = active_example; // String | Active-Y(default)/N/ANY
String perspectiveName = perspectiveName_example; // String | Perspective name
String relationshipType = relationshipType_example; // String | Relationship Type - ALL,FORWARD(Default),REVERSE)
Integer relationshipDepth = 56; // Integer | Relationship Depth- Default 2nd Level
try {
Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RecordsApi#getRecordById");
e.printStackTrace();
}
}
}
import .RecordsApi;
public class RecordsApiExample {
public static void main(String[] args) {
RecordsApi apiInstance = new RecordsApi();
String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
String id = id_example; // String | Record Id
String idExt = idExt_example; // String | Record Id Extension
String authorization = authorization_example; // String | Authorization String
String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
String workItemId = workItemId_example; // String | Work Item ID
Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
Boolean findRootRecord = true; // Boolean | Finds root record only- Default false
String recordState = recordState_example; // String | Record State- CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
String active = active_example; // String | Active-Y(default)/N/ANY
String perspectiveName = perspectiveName_example; // String | Perspective name
String relationshipType = relationshipType_example; // String | Relationship Type - ALL,FORWARD(Default),REVERSE)
Integer relationshipDepth = 56; // Integer | Relationship Depth- Default 2nd Level
try {
Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RecordsApi#getRecordById");
e.printStackTrace();
}
}
}
String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *id = id_example; // Record Id
String *idExt = idExt_example; // Record Id Extension
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *workItemId = workItemId_example; // Work Item ID (optional)
Boolean *includeSystemAttributes = true; // Include System Attribute- Default false (optional)
Boolean *findRootRecord = true; // Finds root record only- Default false (optional)
String *recordState = recordState_example; // Record State- CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional)
String *active = active_example; // Active-Y(default)/N/ANY (optional)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)
String *relationshipType = relationshipType_example; // Relationship Type - ALL,FORWARD(Default),REVERSE) (optional)
Integer *relationshipDepth = 56; // Relationship Depth- Default 2nd Level (optional)
RecordsApi *apiInstance = [[RecordsApi alloc] init];
// Retrieves record by ID and IDEXT
[apiInstance getRecordByIdWith:repositoryName
id:id
idExt:idExt
authorization:authorization
apiVersion:apiVersion
workItemId:workItemId
includeSystemAttributes:includeSystemAttributes
findRootRecord:findRootRecord
recordState:recordState
active:active
perspectiveName:perspectiveName
relationshipType:relationshipType
relationshipDepth:relationshipDepth
completionHandler: ^(Record output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var = require('');
var api = new .RecordsApi()
var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)
var id = id_example; // {String} Record Id
var idExt = idExt_example; // {String} Record Id Extension
var authorization = authorization_example; // {String} Authorization String
var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)
var opts = {
'workItemId': workItemId_example, // {String} Work Item ID
'includeSystemAttributes': true, // {Boolean} Include System Attribute- Default false
'findRootRecord': true, // {Boolean} Finds root record only- Default false
'recordState': recordState_example, // {String} Record State- CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
'active': active_example, // {String} Active-Y(default)/N/ANY
'perspectiveName': perspectiveName_example, // {String} Perspective name
'relationshipType': relationshipType_example, // {String} Relationship Type - ALL,FORWARD(Default),REVERSE)
'relationshipDepth': 56 // {Integer} Relationship Depth- Default 2nd Level
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getRecordById(repositoryName, id, idExt, authorization, apiVersion, opts, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;
namespace Example
{
public class getRecordByIdExample
{
public void main()
{
var apiInstance = new RecordsApi();
var repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
var id = id_example; // String | Record Id
var idExt = idExt_example; // String | Record Id Extension
var authorization = authorization_example; // String | Authorization String
var apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
var workItemId = workItemId_example; // String | Work Item ID (optional)
var includeSystemAttributes = true; // Boolean | Include System Attribute- Default false (optional)
var findRootRecord = true; // Boolean | Finds root record only- Default false (optional)
var recordState = recordState_example; // String | Record State- CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional)
var active = active_example; // String | Active-Y(default)/N/ANY (optional)
var perspectiveName = perspectiveName_example; // String | Perspective name (optional)
var relationshipType = relationshipType_example; // String | Relationship Type - ALL,FORWARD(Default),REVERSE) (optional)
var relationshipDepth = 56; // Integer | Relationship Depth- Default 2nd Level (optional)
try
{
// Retrieves record by ID and IDEXT
Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling RecordsApi.getRecordById: " + e.Message );
}
}
}
}
getRecordById($repositoryName, $id, $idExt, $authorization, $apiVersion, $workItemId, $includeSystemAttributes, $findRootRecord, $recordState, $active, $perspectiveName, $relationshipType, $relationshipDepth);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling RecordsApi->getRecordById: ', $e->getMessage(), PHP_EOL;
}