Trendsic Platform Service

<back to all web services

RecordGetRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/entry/{RecordKey}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class RecordGetRequest
{
    open var RecordKey:String? = null
}

open class RecordGetResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Record:RecordDto? = null
}

open class RecordDto
{
    open var RecordId:Int? = null
    open var RecordKey:String? = null
    open var Name:String? = null
    open var SeriesId:Int? = null
    open var SeriesKey:String? = null
    open var Classification:String? = null
    open var Format:String? = null
    open var Phase:String? = null
    open var TriggerDate:String? = null
    open var Staged:Boolean? = null
    open var HoldId:Int? = null
    open var HoldKey:String? = null
    open var OwnerName:String? = null
    open var Branch:String? = null
    open var Barcode:String? = null
    open var LocJson:String? = null
    open var MetaJson:String? = null
    open var FilesJson:String? = null
    open var VersionsJson:String? = null
    open var RelatedJson:String? = null
    open var DisposedJson:String? = null
    open var CreatedLabel:String? = null
    open var UpdatedLabel:String? = null
    open var Lifecycle:String? = null
    open var RetKind:String? = null
    open var EligibleDate:String? = null
    open var MonthsLeft:Int? = null
}

Kotlin RecordGetRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/records/entry/{RecordKey} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Record: 
	{
		RecordId: 0,
		RecordKey: String,
		Name: String,
		SeriesId: 0,
		SeriesKey: String,
		Classification: String,
		Format: String,
		Phase: String,
		TriggerDate: String,
		Staged: False,
		HoldId: 0,
		HoldKey: String,
		OwnerName: String,
		Branch: String,
		Barcode: String,
		LocJson: String,
		MetaJson: String,
		FilesJson: String,
		VersionsJson: String,
		RelatedJson: String,
		DisposedJson: String,
		CreatedLabel: String,
		UpdatedLabel: String,
		Lifecycle: String,
		RetKind: String,
		EligibleDate: String,
		MonthsLeft: 0
	}
}