Scale 5.9.x to 7.x API Transition Guide

The following outlines the Scale 5.9.x to 7.x API transition for each service endpoint.

Deprecated Services

The following services, along with their endpoints, have been deprecated in Scale v6+:

• /v5/job-executions/
• /v5/configuration/
• /v5/products/
• /v5/sources/

Batch Services

v5		Action	v6+
/v5/batches	GET	List Batches	/v6/batches/	GET
/v5/batches	POST	Create New Batch	/v6/batches/	POST
/v5/batches/validation	POST	Validate Batch	/v6/batches/validation/	POST
/v5/batches/{id}	GET	Get Batch Details	/v6/batches/{id}/	GET
		Batch Comparison	/v6/batches/comparison/{id}	POST
		Edit Batches	/v6/batches/{id}	PATCH

Diagnostic Services

v5		Action	v6
POST	/v5/diagnostics/job/bake	Creates and queues scale bake jobs	/v6/diagnostics/job/bake	POST
POST	/v5/diagnostics/recipe/casino	Creates and queues number of Casino recipes	/v6/diagnostics/recipe/casino/	POST
POST	/v5/diagnostics/job/roulette	Creates and queues scale roulette jobs	/v6/diagnostics/job/roulette/	POST
POST	/v5/diagnostics/job/hello	Create and queue Scale Hello

Error Services

v5		Actions	v6+
GET	/v5/errors	List Errors	/v6/errors	GET
GET	/v5/errors/{id}	Get Error Details	/v6/errors/{id}	GET
POST	/v5/errors	Create error
PATCH	/v5/errors/{id}	Edit Error

Ingest Services

v5		Action	v6
GET	/v5/ingests	Ingest List	/v6/ingests	GET
GET	/v5/ingests/{id}	Ingest details	/v6/ingests/{id}	GET
GET	/v5/ingests/status	Ingest Status	/v6/ingests/status	GET

Job Services

v5		Action	v6
GET	/v5/jobs	Job List	/v6/jobs	GET
GET	/v5/jobs/{id}	View Job Details	/v6/jobs/{id}	GET
GET	/v5/jobs/{id}/input_files	Job Input File List	/v6/jobs/{id}/input_files/	GET
GET	/v5/jobs/{id}/executions	Job execution list	/v6/jobs/{id}/executions	GET
GET	/v5/jobs/{id}/executions/{exe_num}	Job execution details	/v6/jobs/{id}/executions/{exe_num}	GET
POST	/v5/jobs/cancel	Cancel job(s)	/v6/jobs/cancel	POST
POST	/v5/jobs/requeue	Requeue Jobs	/v6/jobs/requeue	POST
PATCH	/v5/jobs/{id}	Update Job
GET	/v5/jobs/updates	View Job Updates
GET	/v5/jobs/executions	Job with execution list
		Queue new job	/v6/jobs	POST
		Job execution log	/v6/job-executions/{job_exe_id}/logs/{log_id}	GET

The /v5/job-executions endpoint was deprecated in v6

v5		Action	v6
GET	/v5/job-types	List Job Types	/v6/job-types	GET
POST	/v5/job-types	Create Job Type	/v6/job-types/	POST
POST	/v5/job-types/validation	Validate Job Type	/v6/job-types/validation/	POST
GET	/v5/job-types/status	Get Job Type Status	/v6/job-types/status	GET
GET	/v5/job-types/pending	Get Pending Job Types	/v6/job-types/pending	GET
GET	/v5/job-types/running	Get Running Job Types	/v6/job-types/running	GET
GET	/v5/job-types/system-failures	Get Job Types System Failures	/v6/job-types/system-failures	GET
GET	/v5/job-types/{id}	Get Job Type Details	/v6/job-types/{name}/{version}	GET
PATCH	/v5/job-types/{id}	Edit Job type	/v6/job-types/{name}/{version}	PATCH
		List Job Type Names	/v6/job-type-names	GET
		Job Type Versions	/v6/job-types/{name}	GET
		Job Type Revisions	/v6/job-types/{name}/{version}/revisions	GET
		Job Type Revision Details	/v6/job-types/{name}/{version}/revisions/{revision_num}	GET

Metrics Services

v5		Action	v6
GET	/v5/metrics	Metrics List	/v6/metrics	GET
GET	/v5/metrics/{name}	Metric Details	/v6/metrics/{name}	GET
GET	/v5/metrics/{name}/plot-data	Metric Plot Data	/v6/metrics/{name}/plot-data	GET

Node Services

v5		Action	v6
GET	/v5/nodes	Node List	/v6/nodes	GET
GET	/v5/nodes/{id}	Node Details	/v6/nodes/{id}	GET
PATCH	/v5/nodes/{id}	Update node	/v6/nodes/{id}	PATCH

Queue Services

v5		Action	v6+
GET	/v5/load	Get Job Queue Load	/v6/load	GET
GET	/v5/queue/status	Queue stauts	/v6/queue/status	GET
POST	/v5/queue/new-job	Queue new job	/v6/jobs	POST
POST	/v5/queue/requeue-jobs	Requeue job	/v6/jobs/requeue	POST
POST	/v5/queue/new-recipe	Queue new recipe	/v6/recipes	POST

Recipe Services

v5		Action	v6+
GET	/v5/recipes	List Recipes	/v6/recipes	GET
GET	/v5/recipes/{id}	View Recipe Details	/v6/recipes/{id}	GET
POST	/v5/recipes/{id}/reprocess	Reprocess Recipe	/v6/recipes/{id}/reprocess	POST
GET	/v5/recipes/{id}/input_files	View Recipe Input File List	/v6/recipes/{id}/input_files	GET
		Queue new recipe	/v6/recipes	POST

Recipe Type Services

v5		Action	v6+
GET	/v5/recipe-types	Recipe Type List	/v6/recipe-types	GET
POST	/v5/recipe-types	Create recipe type	/v6/recipe-types	POST
POST	/v5/recipe-types/validation	Validate recipe type	/v6/recipe-types/validation	POST
GET	/v5/recipe-types/{id}	Recipe Type Details	/v6/recipe-types/{name}	GET
PATCH	/v5/recipe-types/{id}	Edit recipe type	/v6/recipe-types/{name}	PATCH
		View Recipe type revisions	/v6/recipe-types/{name}/revisions	GET
		View recipe type revision details	/v6/recipe-types/{name}/revisions/{revision_num}	GET

Scale File Services

v5		Action	v6
GET	/v5/files	List Scale Files	/v6/files	GET
		File details	/v6/files/{id}	GET
		Purge source file	/v6/files/purge-source	POST

Scans Services

v5		Action	v6+
GET	/v5/scans	List Scans	/v6/scans	GET
POST	/v5/scans	Create Scans	/v6/scans	POST
GET	/v5/scans/{id}	View Scan Details	/v6/scans/{id}	GET
POST	/v5/scans/validation	Validate Scan	/v6/scans/validation	POST
PATCH	/v5/scans/{id}	Edit Scan	/v6/scans/{id}	PATCH
POST	/v5/scans/{id}/process	Process Scan	/v6/scans/{id}/process	POST

Scheduler Services

v5		Action	v6
GET	/v5/scheduler	Get Scheduler Info	/v6/scheduler	GET
POST	/v5/scheduler	Update scheduler	/v6/scheduler	POST

Strike Services

v5		Action	v6+
GET	/v5/strikes	List Strikes	/v6/strikes	GET
POST	/v5/strikes	Create Strike	/v6/strikes	POST
GET	/v5/strikes/{id}	Get Strike Details	/v6/strikes/{id}	GET
POST	/v5/strikes/validation	Validate Strike	/v6/strikes/validation	POST
PATCH	/v5/strikes/{id}	Edit Strike	/v6/strikes/{id}	PATCH

System Services

v5		Action	v6
GET	/v5/status	Get Scheduler status	/v6/status	GET
GET	/v5/version	Get System Version	/v6/version	GET

Workspace Services

v5		Action	v6+
GET	/v5/workspaces	List Workspaces	/v6/workspaces	GET
POST	/v5/workspaces	Create workspace	/v6/workspaces	POST
GET	/v5/workspace/{id}	Get Workspace Details	/v6/workspace/{id}	GET
POST	/v5/workspaces/validation	Validate Workspace	/v6/workspaces/validation	POST
POST	/v5/workspaces/{id}	Edit workspace	/v6/workspaces/{id}	POST