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}

export class RecordDto
{
    public RecordId: number;
    public RecordKey: string;
    public Name: string;
    public SeriesId?: number;
    public SeriesKey: string;
    public Classification: string;
    public Format: string;
    public Phase: string;
    public TriggerDate: string;
    public Staged: boolean;
    public HoldId?: number;
    public HoldKey: string;
    public OwnerName: string;
    public Branch: string;
    public Barcode: string;
    public LocJson: string;
    public MetaJson: string;
    public FilesJson: string;
    public VersionsJson: string;
    public RelatedJson: string;
    public DisposedJson: string;
    public CreatedLabel: string;
    public UpdatedLabel: string;
    public Lifecycle: string;
    public RetKind: string;
    public EligibleDate: string;
    public MonthsLeft: number;

    public constructor(init?: Partial<RecordDto>) { (Object as any).assign(this, init); }
}

export class RecordGetResponse
{
    public ResponseStatus: ResponseStatus;
    public Record: RecordDto;

    public constructor(init?: Partial<RecordGetResponse>) { (Object as any).assign(this, init); }
}

export class RecordGetRequest
{
    public RecordKey: string;

    public constructor(init?: Partial<RecordGetRequest>) { (Object as any).assign(this, init); }
}

TypeScript RecordGetRequest DTOs

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

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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}}