Foundry API

<back to all web services

AbortActiveJobRequest

Requires Authentication
The following routes are available for this service:
PUT/jobs/active/abort

export class PutPatchOperationUnTenanted<TResponse> implements IPatch, IPut
{

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

export class PutPatchOperationTenanted<TResponse> extends PutPatchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

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

export class Job implements IIdentifiableResource
{
    public machineId?: string;
    public name?: string;
    public totalLayers: number;
    public startedAt: string;
    public finishedAt?: string;
    public aborted: boolean;
    public id?: string;

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

export class AbortActiveJobResponse
{
    public responseStatus?: ResponseStatus;
    public job?: Job;

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

export class AbortActiveJobRequest extends PutPatchOperationTenanted<AbortActiveJobResponse>
{
    public machineId?: string;

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

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

PUT /jobs/active/abort HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	machineId: String,
	organisationId: String
}
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
		}
	},
	job: 
	{
		machineId: String,
		name: String,
		totalLayers: 0,
		finishedAt: ,
		aborted: False,
		id: String
	}
}