All URIs are relative to https://mc.zaikio.com/api/v1/
Method | HTTP request | Description |
---|---|---|
fileActionsFileActionIdDelete | DELETE /file_actions/{file_action_id} | |
fileActionsFileActionIdFileRemarksGet | GET /file_actions/{file_action_id}/file_remarks | |
fileActionsFileActionIdFileRemarksPost | POST /file_actions/{file_action_id}/file_remarks | |
fileActionsFileActionIdGet | GET /file_actions/{file_action_id} | |
fileActionsFileActionIdPatch | PATCH /file_actions/{file_action_id} | |
fileReferencesFileReferenceIdDelete | DELETE /file_references/{file_reference_id} | |
fileReferencesFileReferenceIdFileActionsGet | GET /file_references/{file_reference_id}/file_actions | |
fileReferencesFileReferenceIdFileActionsPost | POST /file_references/{file_reference_id}/file_actions | |
fileReferencesFileReferenceIdGet | GET /file_references/{file_reference_id} | |
finishingsFinishingIdDelete | DELETE /finishings/{finishing_id} | |
finishingsFinishingIdFileReferencesGet | GET /finishings/{finishing_id}/file_references | |
finishingsFinishingIdFileReferencesPost | POST /finishings/{finishing_id}/file_references | |
finishingsFinishingIdFinishingApplicationsFinishingApplicationIdDelete | DELETE /finishings/{finishing_id}/finishing_applications/{finishing_application_id} | |
finishingsFinishingIdFinishingApplicationsFinishingApplicationIdGet | GET /finishings/{finishing_id}/finishing_applications/{finishing_application_id} | |
finishingsFinishingIdFinishingApplicationsGet | GET /finishings/{finishing_id}/finishing_applications | |
finishingsFinishingIdFinishingApplicationsPost | POST /finishings/{finishing_id}/finishing_applications | |
finishingsFinishingIdGet | GET /finishings/{finishing_id} | |
finishingsFinishingIdPatch | PATCH /finishings/{finishing_id} | |
jobsGet | GET /jobs | |
jobsJobIdDelete | DELETE /jobs/{job_id} | |
jobsJobIdGet | GET /jobs/{job_id} | |
jobsJobIdPackagingsGet | GET /jobs/{job_id}/packagings | |
jobsJobIdPackagingsPost | POST /jobs/{job_id}/packagings | |
jobsJobIdPartsGet | GET /jobs/{job_id}/parts | |
jobsJobIdPartsPost | POST /jobs/{job_id}/parts | |
jobsJobIdPatch | PATCH /jobs/{job_id} | |
jobsPost | POST /jobs | |
packagingsPackagingIdDelete | DELETE /packagings/{packaging_id} | |
packagingsPackagingIdGet | GET /packagings/{packaging_id} | |
packagingsPackagingIdPatch | PATCH /packagings/{packaging_id} | |
partsPartIdColorsColorIdDelete | DELETE /parts/{part_id}/colors/{color_id} | |
partsPartIdColorsColorIdGet | GET /parts/{part_id}/colors/{color_id} | |
partsPartIdColorsColorIdPatch | PATCH /parts/{part_id}/colors/{color_id} | |
partsPartIdColorsGet | GET /parts/{part_id}/colors | |
partsPartIdColorsPost | POST /parts/{part_id}/colors | |
partsPartIdDelete | DELETE /parts/{part_id} | |
partsPartIdDesiredSubstrateDelete | DELETE /parts/{part_id}/desired_substrate | |
partsPartIdDesiredSubstrateGet | GET /parts/{part_id}/desired_substrate | |
partsPartIdDesiredSubstratePatch | PATCH /parts/{part_id}/desired_substrate | |
partsPartIdDesiredSubstratePost | POST /parts/{part_id}/desired_substrate | |
partsPartIdFileReferencesGet | GET /parts/{part_id}/file_references | |
partsPartIdFileReferencesPost | POST /parts/{part_id}/file_references | |
partsPartIdFinishingsGet | GET /parts/{part_id}/finishings | |
partsPartIdFinishingsPost | POST /parts/{part_id}/finishings | |
partsPartIdGet | GET /parts/{part_id} | |
partsPartIdPatch | PATCH /parts/{part_id} |
fileActionsFileActionIdDelete(fileActionId)
Removes a file action. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileActionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileActionsFileActionIdDelete(fileActionId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileActionId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
[FileRemark] fileActionsFileActionIdFileRemarksGet(fileActionId, opts)
Get all file remarks of a file action. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileActionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.fileActionsFileActionIdFileRemarksGet(fileActionId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileActionId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
FileRemark fileActionsFileActionIdFileRemarksPost(body, fileActionId)
Creates a file remark. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FileActionIdFileRemarksBody(); // FileActionIdFileRemarksBody |
let fileActionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileActionsFileActionIdFileRemarksPost(body, fileActionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FileActionIdFileRemarksBody | ||
fileActionId | String |
- Content-Type: application/json
- Accept: application/json
FileAction fileActionsFileActionIdGet(fileActionId)
Returns a specific file action. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileActionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileActionsFileActionIdGet(fileActionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileActionId | String |
- Content-Type: Not defined
- Accept: application/json
FileAction fileActionsFileActionIdPatch(body, fileActionId)
Modifies file action. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FileActionsFileActionIdBody(); // FileActionsFileActionIdBody |
let fileActionId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileActionsFileActionIdPatch(body, fileActionId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FileActionsFileActionIdBody | ||
fileActionId | String |
- Content-Type: application/json
- Accept: application/json
fileReferencesFileReferenceIdDelete(fileReferenceId)
Removes the file reference from it's referenceable, which is a part or a finishing. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileReferenceId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileReferencesFileReferenceIdDelete(fileReferenceId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileReferenceId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
[FileAction] fileReferencesFileReferenceIdFileActionsGet(fileReferenceId, opts)
Get all file actions of a file reference. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileReferenceId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.fileReferencesFileReferenceIdFileActionsGet(fileReferenceId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileReferenceId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
FileAction fileReferencesFileReferenceIdFileActionsPost(body, fileReferenceId)
Creates a file action. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FileReferenceIdFileActionsBody(); // FileReferenceIdFileActionsBody |
let fileReferenceId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileReferencesFileReferenceIdFileActionsPost(body, fileReferenceId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FileReferenceIdFileActionsBody | ||
fileReferenceId | String |
- Content-Type: application/json
- Accept: application/json
FileReference fileReferencesFileReferenceIdGet(fileReferenceId)
Returns a specific file reference. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let fileReferenceId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.fileReferencesFileReferenceIdGet(fileReferenceId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
fileReferenceId | String |
- Content-Type: Not defined
- Accept: application/json
finishingsFinishingIdDelete(finishingId)
Removes the finishing from a part. The finishing itself is destroyed by this operation including all of it's applications. If you only want to detach a finishing from one part please remove the finishing application for that part instead. Finishings can only be removed as long as the parent jobs is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdDelete(finishingId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
[FileReference] finishingsFinishingIdFileReferencesGet(finishingId, opts)
Returns all file references of a specific finishing. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.finishingsFinishingIdFileReferencesGet(finishingId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
FileReference finishingsFinishingIdFileReferencesPost(body, finishingId)
Creates a new file reference for a specific finishing. File referenes can only be added or modified as long as the job has not been `completed` or `canceled`. This means, that file references can be modified for production jobs. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FinishingIdFileReferencesBody(); // FinishingIdFileReferencesBody |
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdFileReferencesPost(body, finishingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FinishingIdFileReferencesBody | ||
finishingId | String |
- Content-Type: application/json
- Accept: application/json
finishingsFinishingIdFinishingApplicationsFinishingApplicationIdDelete(finishingId, finishingApplicationId)
Removes a finishing application from a specific finishing. If a finishing is left without any applications after this removal, the finishing itself will be automatically destroyed as well. Removing finishing applications is only possible if the parent job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let finishingApplicationId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdFinishingApplicationsFinishingApplicationIdDelete(finishingId, finishingApplicationId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String | ||
finishingApplicationId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
FinishingApplication finishingsFinishingIdFinishingApplicationsFinishingApplicationIdGet(finishingId, finishingApplicationId)
Returns a specific finishing application. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let finishingApplicationId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdFinishingApplicationsFinishingApplicationIdGet(finishingId, finishingApplicationId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String | ||
finishingApplicationId | String |
- Content-Type: Not defined
- Accept: application/json
[FinishingApplication] finishingsFinishingIdFinishingApplicationsGet(finishingId, opts)
Returns all finishing applications of a specific finishing. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.finishingsFinishingIdFinishingApplicationsGet(finishingId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
FinishingApplication finishingsFinishingIdFinishingApplicationsPost(body, finishingId)
Creates a new finishing application for a specific finshing and part. Finshing applications can only be added as long as the job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FinishingIdFinishingApplicationsBody(); // FinishingIdFinishingApplicationsBody |
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdFinishingApplicationsPost(body, finishingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FinishingIdFinishingApplicationsBody | ||
finishingId | String |
- Content-Type: application/json
- Accept: application/json
Finishing finishingsFinishingIdGet(finishingId)
Returns a specific finishing. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdGet(finishingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
finishingId | String |
- Content-Type: Not defined
- Accept: application/json
Finishing finishingsFinishingIdPatch(body, finishingId)
- needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.FinishingsFinishingIdBody(); // FinishingsFinishingIdBody |
let finishingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.finishingsFinishingIdPatch(body, finishingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | FinishingsFinishingIdBody | ||
finishingId | String |
- Content-Type: application/json
- Accept: application/json
[Job] jobsGet(opts)
Returns all jobs that have a connection to the `Organization` from your token. This means that those jobs might have been created by that organization, are produced by it, some parts have been outsourced to it, or the organization is the customer which ordered a job. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.jobsGet(opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
jobsJobIdDelete(jobId)
Removes or specific job while this job is still a `draft`. If the job is not in a `draft` state anymore the job will be canceled. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.jobsJobIdDelete(jobId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
jobId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
InlineResponse200 jobsJobIdGet(jobId)
Returns a specific job, including it's entire defintion like compments, their colors, finishings, finishing applications and desired substrate information. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.jobsJobIdGet(jobId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
jobId | String |
- Content-Type: Not defined
- Accept: application/json
[Packaging] jobsJobIdPackagingsGet(jobId, opts)
Returns all packagings of a specific jobs - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.jobsJobIdPackagingsGet(jobId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
jobId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
Packaging jobsJobIdPackagingsPost(body, jobId)
Creates a new packaging for the specified job. Packagings can only be added or modified as long as the job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.JobIdPackagingsBody(); // JobIdPackagingsBody |
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.jobsJobIdPackagingsPost(body, jobId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | JobIdPackagingsBody | ||
jobId | String |
- Content-Type: application/json
- Accept: application/json
[Part] jobsJobIdPartsGet(jobId, opts)
Returns all parts of a specific job - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.jobsJobIdPartsGet(jobId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
jobId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
Part jobsJobIdPartsPost(body, jobId)
Creates a new part for the specified job. Parts can only be added or modified as long as the job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.JobIdPartsBody(); // JobIdPartsBody |
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.jobsJobIdPartsPost(body, jobId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | JobIdPartsBody | ||
jobId | String |
- Content-Type: application/json
- Accept: application/json
Job jobsJobIdPatch(body, jobId)
Changes the attributes on a job. Please not that most attributes cannot be changed anymore, once the job is no longer a draft. If you try to change a frozen attribute, you will receive a 422 error. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.JobsJobIdBody(); // JobsJobIdBody |
let jobId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.jobsJobIdPatch(body, jobId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | JobsJobIdBody | ||
jobId | String |
- Content-Type: application/json
- Accept: application/json
Job jobsPost(body)
Creates a new job. When creating jobs you may supply information for parts (including colors, finishings, desired substrate) as well. Please see the respective documentation for parameters. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.JobsBody(); // JobsBody |
apiInstance.jobsPost(body).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | JobsBody |
- Content-Type: application/json
- Accept: application/json
packagingsPackagingIdDelete(packagingId)
Removes a specific packaging, which also unassigns it from its job. Removing packagings is only possible while the attached job is still in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let packagingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.packagingsPackagingIdDelete(packagingId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
packagingId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
Packaging packagingsPackagingIdGet(packagingId)
Returns a specific packaging. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let packagingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.packagingsPackagingIdGet(packagingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
packagingId | String |
- Content-Type: Not defined
- Accept: application/json
Packaging packagingsPackagingIdPatch(body, packagingId)
Modifies a specific packagings. Packagings can only be modified as long as their parent job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PackagingsPackagingIdBody(); // PackagingsPackagingIdBody |
let packagingId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.packagingsPackagingIdPatch(body, packagingId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PackagingsPackagingIdBody | ||
packagingId | String |
- Content-Type: application/json
- Accept: application/json
partsPartIdColorsColorIdDelete(partId, colorId)
Removes a specific color from a part, as long as the job is still a draft. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let colorId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdColorsColorIdDelete(partId, colorId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String | ||
colorId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
Color partsPartIdColorsColorIdGet(partId, colorId)
Returns a specific color from a part. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let colorId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdColorsColorIdGet(partId, colorId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String | ||
colorId | String |
- Content-Type: Not defined
- Accept: application/json
Color partsPartIdColorsColorIdPatch(body, partId, colorId)
Changes attributes on a specific color from a part, as long as job is still a draft. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.ColorsColorIdBody(); // ColorsColorIdBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let colorId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdColorsColorIdPatch(body, partId, colorId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | ColorsColorIdBody | ||
partId | String | ||
colorId | String |
- Content-Type: application/json
- Accept: application/json
[Color] partsPartIdColorsGet(partId, opts)
Returns all colors from a job's part. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.partsPartIdColorsGet(partId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
Color partsPartIdColorsPost(body, partId)
Creates a new color and attaches it to the selected part with the given parameters. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartIdColorsBody(); // PartIdColorsBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdColorsPost(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartIdColorsBody | ||
partId | String |
- Content-Type: application/json
- Accept: application/json
partsPartIdDelete(partId)
Removes a specific part, which also unassigns it from its job. Removing parts is only possible while the attached job is still in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdDelete(partId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
partsPartIdDesiredSubstrateDelete(partId)
Removes the desired substrate information from a specific part as long as the job to which the part belongs is still a draft. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdDesiredSubstrateDelete(partId).then(() => {
console.log('API called successfully.');
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String |
null (empty response body)
- Content-Type: Not defined
- Accept: application/json
DesiredSubstrate partsPartIdDesiredSubstrateGet(partId)
Returns the desired substrate information. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdDesiredSubstrateGet(partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String |
- Content-Type: Not defined
- Accept: application/json
DesiredSubstrate partsPartIdDesiredSubstratePatch(body, partId)
Modifies the desired substrate information from a specific part as long as the job to which the part belongs is still a draft. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartIdDesiredSubstrateBody1(); // PartIdDesiredSubstrateBody1 |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdDesiredSubstratePatch(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartIdDesiredSubstrateBody1 | ||
partId | String |
- Content-Type: application/json
- Accept: application/json
DesiredSubstrate partsPartIdDesiredSubstratePost(body, partId)
Creates new desired substrate information. If desired substrate information is already present, it will be overwritten. Creating desired substrate information is only possible as long as the job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.w` or `mission_control.jobs.rw`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartIdDesiredSubstrateBody(); // PartIdDesiredSubstrateBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdDesiredSubstratePost(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartIdDesiredSubstrateBody | ||
partId | String |
- Content-Type: application/json
- Accept: application/json
[FileReference] partsPartIdFileReferencesGet(partId, opts)
Returns all file references of a specific part. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.partsPartIdFileReferencesGet(partId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
FileReference partsPartIdFileReferencesPost(body, partId)
Creates a new file reference for a specific part. File referenes can only be added or modified as long as the job has not been `completed` or `canceled`. This means, that file references can be modified for production jobs. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartIdFileReferencesBody(); // PartIdFileReferencesBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdFileReferencesPost(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartIdFileReferencesBody | ||
partId | String |
- Content-Type: application/json
- Accept: application/json
[Finishing] partsPartIdFinishingsGet(partId, opts)
Returns all finishings of a specific part. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
let opts = {
'page': 56, // Number | The page of the current collection that shall be returned
'perPage': 100 // Number | The maximum number of items included in the response, ie., the page size
};
apiInstance.partsPartIdFinishingsGet(partId, opts).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String | ||
page | Number | The page of the current collection that shall be returned | [optional] |
perPage | Number | The maximum number of items included in the response, ie., the page size | [optional] [default to 100] |
- Content-Type: Not defined
- Accept: application/json
Finishing partsPartIdFinishingsPost(body, partId)
Creates a new finishing for a specific part. Finishings can only be added or modified as long as the job they belong to is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartIdFinishingsBody(); // PartIdFinishingsBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdFinishingsPost(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartIdFinishingsBody | ||
partId | String |
- Content-Type: application/json
- Accept: application/json
ExtendedPart partsPartIdGet(partId)
Returns a specific part, including its entire defintion with colors, finishings, finishing applications and desired substrate information. - needed bearer: `Organization` or `Person` - needed scopes: `mission_control.jobs.r`
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdGet(partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
partId | String |
- Content-Type: Not defined
- Accept: application/json
Part partsPartIdPatch(body, partId)
Modifies a specific part. Parts can only be modified as long as their parent job is in a `draft` state. - needed bearer: `Organization` or `Person` - needed scopes:
import {MissionControl} from 'mission_control';
let defaultClient = MissionControl.ApiClient.instance;
let apiInstance = new MissionControl.SpecificationApi();
let body = new MissionControl.PartsPartIdBody(); // PartsPartIdBody |
let partId = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // String |
apiInstance.partsPartIdPatch(body, partId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, (error) => {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
body | PartsPartIdBody | ||
partId | String |
- Content-Type: application/json
- Accept: application/json