Trendsic Platform Service

<back to all web services

PlanSetMakeCurrentRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/plansets/{PlanSetUID}/make-current

export class SheetPin
{
    public SheetPinID: number;
    public SheetID: number;
    public EntityType: string;
    public EntityID?: number;
    public EntityUID?: string;
    public X: number;
    public Y: number;
    public Label: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public EntityNo: string;
    public EntityTitle: string;
    public EntityStatus: string;
    public InspectionUID?: string;
    public SheetNumber: string;
    public SheetTitle: string;
    public PlanSetID?: number;
    public PlanSetUID?: string;
    public PlanSetName: string;

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

export class Sheet
{
    public SheetID: number;
    public PlanSetID: number;
    public PlanSetUID?: string;
    public PlanSetName: string;
    public ProjectID: number;
    public PageIndex: number;
    public AttachmentId: string;
    public VersionNo: number;
    public SheetNumber: string;
    public SheetKey: string;
    public Title: string;
    public Discipline: string;
    public Revision: string;
    public RevisionDate?: string;
    public WidthPt: number;
    public HeightPt: number;
    public ThumbKey: string;
    public ThumbUrl: string;
    public ThumbHash: string;
    public ExtractSource: string;
    public Confidence?: number;
    public ChangeKind: string;
    public SupersedesSheetID?: number;
    public IsCurrent: boolean;
    public PinCount: number;
    public UpdatedBy: string;
    public UpdatedAt?: string;
    public Pins: SheetPin[] = [];

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

export class PlanSet
{
    public PlanSetID: number;
    public PlanSetUID: string;
    public ProjectID: number;
    public Name: string;
    public Source: string;
    public SourceLabel: string;
    public IssuedDate?: string;
    public AttachmentId: string;
    public AttachmentName: string;
    public FileSizeInKB?: number;
    public VersionNo: number;
    public Status: string;
    public Progress: number;
    public PageCount: number;
    public SheetCount: number;
    public ExtractMode: string;
    public ErrorText: string;
    public SupersedesPlanSetID?: number;
    public SupersedesName: string;
    public IsCurrent: boolean;
    public CreatedBy: string;
    public CreatedAt?: string;
    public ProcessedAt?: string;
    public AgeSeconds: number;
    public Sheets: Sheet[] = [];
    public Headline: string;

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

export class PlanSetResponse
{
    public ResponseStatus: ResponseStatus;
    public PlanSet: PlanSet;
    public RemovedSheets: Sheet[] = [];

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

export class PlanSetMakeCurrentRequest
{
    public PlanSetUID: string;

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

TypeScript PlanSetMakeCurrentRequest 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.

POST /v1/plansets/{PlanSetUID}/make-current HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PlanSetUID: 00000000000000000000000000000000
}
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
		}
	},
	PlanSet: 
	{
		PlanSetID: 0,
		PlanSetUID: 00000000000000000000000000000000,
		ProjectID: 0,
		Name: String,
		Source: String,
		SourceLabel: String,
		IssuedDate: 0001-01-01,
		AttachmentId: 00000000000000000000000000000000,
		AttachmentName: String,
		FileSizeInKB: 0,
		VersionNo: 0,
		Status: String,
		Progress: 0,
		PageCount: 0,
		SheetCount: 0,
		ExtractMode: String,
		ErrorText: String,
		SupersedesPlanSetID: 0,
		SupersedesName: String,
		IsCurrent: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		ProcessedAt: 0001-01-01,
		AgeSeconds: 0,
		Sheets: 
		[
			{
				SheetID: 0,
				PlanSetID: 0,
				PlanSetUID: 00000000000000000000000000000000,
				PlanSetName: String,
				ProjectID: 0,
				PageIndex: 0,
				AttachmentId: 00000000000000000000000000000000,
				VersionNo: 0,
				SheetNumber: String,
				SheetKey: String,
				Title: String,
				Discipline: String,
				Revision: String,
				RevisionDate: 0001-01-01,
				WidthPt: 0,
				HeightPt: 0,
				ThumbKey: String,
				ThumbUrl: String,
				ThumbHash: String,
				ExtractSource: String,
				Confidence: 0,
				ChangeKind: String,
				SupersedesSheetID: 0,
				IsCurrent: False,
				PinCount: 0,
				UpdatedBy: String,
				UpdatedAt: 0001-01-01,
				Pins: 
				[
					{
						SheetPinID: 0,
						SheetID: 0,
						EntityType: String,
						EntityID: 0,
						EntityUID: 00000000000000000000000000000000,
						X: 0,
						Y: 0,
						Label: String,
						CreatedBy: String,
						CreatedAt: 0001-01-01,
						EntityNo: String,
						EntityTitle: String,
						EntityStatus: String,
						InspectionUID: 00000000000000000000000000000000,
						SheetNumber: String,
						SheetTitle: String,
						PlanSetID: 0,
						PlanSetUID: 00000000000000000000000000000000,
						PlanSetName: String
					}
				]
			}
		],
		Headline: String
	},
	RemovedSheets: 
	[
		{
			SheetID: 0,
			PlanSetID: 0,
			PlanSetUID: 00000000000000000000000000000000,
			PlanSetName: String,
			ProjectID: 0,
			PageIndex: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			SheetNumber: String,
			SheetKey: String,
			Title: String,
			Discipline: String,
			Revision: String,
			RevisionDate: 0001-01-01,
			WidthPt: 0,
			HeightPt: 0,
			ThumbKey: String,
			ThumbUrl: String,
			ThumbHash: String,
			ExtractSource: String,
			Confidence: 0,
			ChangeKind: String,
			SupersedesSheetID: 0,
			IsCurrent: False,
			PinCount: 0,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			Pins: 
			[
				{
					SheetPinID: 0,
					SheetID: 0,
					EntityType: String,
					EntityID: 0,
					EntityUID: 00000000000000000000000000000000,
					X: 0,
					Y: 0,
					Label: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					EntityNo: String,
					EntityTitle: String,
					EntityStatus: String,
					InspectionUID: 00000000000000000000000000000000,
					SheetNumber: String,
					SheetTitle: String,
					PlanSetID: 0,
					PlanSetUID: 00000000000000000000000000000000,
					PlanSetName: String
				}
			]
		}
	]
}