Trendsic Platform Service

<back to all web services

DispositionQueueRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/disposition/queue
"use strict";
export class RecordDto {
    /** @param {{RecordId?:number,RecordKey?:string,Name?:string,SeriesId?:number,SeriesKey?:string,Classification?:string,Format?:string,Phase?:string,TriggerDate?:string,Staged?:boolean,HoldId?:number,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?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RecordId;
    /** @type {string} */
    RecordKey;
    /** @type {string} */
    Name;
    /** @type {?number} */
    SeriesId;
    /** @type {string} */
    SeriesKey;
    /** @type {string} */
    Classification;
    /** @type {string} */
    Format;
    /** @type {string} */
    Phase;
    /** @type {string} */
    TriggerDate;
    /** @type {boolean} */
    Staged;
    /** @type {?number} */
    HoldId;
    /** @type {string} */
    HoldKey;
    /** @type {string} */
    OwnerName;
    /** @type {string} */
    Branch;
    /** @type {string} */
    Barcode;
    /** @type {string} */
    LocJson;
    /** @type {string} */
    MetaJson;
    /** @type {string} */
    FilesJson;
    /** @type {string} */
    VersionsJson;
    /** @type {string} */
    RelatedJson;
    /** @type {string} */
    DisposedJson;
    /** @type {string} */
    CreatedLabel;
    /** @type {string} */
    UpdatedLabel;
    /** @type {string} */
    Lifecycle;
    /** @type {string} */
    RetKind;
    /** @type {string} */
    EligibleDate;
    /** @type {number} */
    MonthsLeft;
}
export class RecordsSearchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Records?:RecordDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordDto[]} */
    Records = [];
}
export class DispositionQueueRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript DispositionQueueRequest 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/disposition/queue 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
		}
	},
	Records: 
	[
		{
			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
		}
	]
}