Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "63425e67-e5d5-4ac5-880a-826b94f416f4",
"jobs_id": "49897110-9be3-4318-b7d3-7de45b3678fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4f9509d6-7c2c-48a8-a6ff-0974fe1ad31f",
"_parent_id": "826371e3-3bba-4172-8c27-eaa402ffa0bb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "014413aa-484f-4d9c-8496-a1b3e4a456e2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "49e78a65-3e32-45e6-8fc7-47d6cfabe85e",
"_parent_id": "1e0ea131-7ebf-4f12-9c68-7cd7a5754be7",
"root_parent_id": "84ac8d54-349a-4c56-bfe7-f4d68fb7f285",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e6a61f46-e73f-48c1-98b5-56791d5e09df",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d6323dab-bc71-42f3-a115-739112fc3496",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "18b17825-37b3-421f-af70-8f2f35493517",
"_parent_code": "sample string 6",
"sales_organization_id": "1d047338-760e-4f4b-8c33-9e34e929dd45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"equipment_model_id": "58aff234-45dd-46d9-bb40-9c0e6744d7c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c3814f38-47d7-47c8-bd56-1b5c952608c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "943e71a6-6b97-4b2e-a465-83b05a072a84",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f8456197-0f68-45b7-befa-34a344a9e49f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e68039ea-7c54-4d46-b5ee-0e679a91841f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"equipment_family_id": "6386cde2-e9f6-474d-8867-043acf188574",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d6323dab-bc71-42f3-a115-739112fc3496",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "18b17825-37b3-421f-af70-8f2f35493517",
"_parent_code": "sample string 6",
"sales_organization_id": "1d047338-760e-4f4b-8c33-9e34e929dd45",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"date_in_production_since": "2026-08-23T11:28:58.1806394+00:00",
"date_out_of_production_since": "2026-08-23T11:28:58.1806394+00:00",
"date_end_support": "2026-08-23T11:28:58.1806394+00:00",
"sales_organization_id": "bcd14463-ca72-4602-bbc1-65943f39f907",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"project_status_id": "112e90a9-7298-4a9e-9206-854835ea48e3",
"project_status_code": "sample string 10",
"project_status": {
"id": "77569994-ccdf-457f-9b11-090f403d6d6f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "498833ef-07b2-4722-95b7-2d2b8e85da3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"company_id": "a662ecc5-2248-44cf-96af-4d5d407fc77e",
"company_code": "sample string 12",
"db_address_id": "f3ead394-c41a-4a58-b717-f8226e50cc5b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b3ab246-c7a3-4851-b269-b19a993473c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "368b6f93-484c-49c9-958e-708f8ff91586",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-08-23T11:28:58.1806394+00:00",
"date_create": "2026-08-23T11:28:58.1806394+00:00",
"date_update": "2026-08-23T11:28:58.1806394+00:00",
"updated_by_user_id": "249cdcbd-27fd-4931-9950-6bf24a0533fb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-23T11:28:58.1806394+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-08-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-23T11:28:58.1806394+00:00",
"date_last_job": "2026-08-23T11:28:58.1806394+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-23T11:28:58.1806394+00:00",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d9075a2-4b72-4cbe-a3ae-5285820c9c7b",
"job_type_code": "sample string 7",
"job_type": {
"id": "9485adbc-8564-4f4a-856f-b3b54df25f3f",
"name": "sample string 2",
"sales_organization_id": "3f008a5b-baea-421e-b84e-32926ef5711b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00",
"code": "sample string 7"
},
"job_priority_id": "0770625f-c614-4efc-8e47-0effd89aeea9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e43d59f-e11c-4e03-b52f-2d1eb74f7d11",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c8be2f9f-6233-46ba-9a00-580f25d5fdb4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"job_status_id": "1c121aa4-5e09-4a02-8ea0-bf48e2595a5d",
"job_status_code": "sample string 11",
"db_address_id": "16cb6c10-c981-4824-95dd-86449b349c1b",
"contact_id": "ad8612cd-747d-459e-a945-3d5a214621d4",
"requested_by_company_id": "0541ea2f-cb91-429b-bff3-5c2892431df6",
"requested_by_contact_id": "9ff6360c-6088-4148-b52e-abcda54149f6",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-08-23T11:28:58.1806394+00:00",
"due_date": "2026-08-23T11:28:58.1806394+00:00",
"date_create": "2026-08-23T11:28:58.1806394+00:00",
"date_update": "2026-08-23T11:28:58.1806394+00:00",
"date_closed": "2026-08-23T11:28:58.1806394+00:00",
"suggested_user_id": "6bd2cb51-290f-4588-907e-e9a8a71c4943",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aa6115c3-b8ee-43e8-b606-c9a08931224b",
"db_language_id": "7a0ede40-d860-48af-8326-694daf978e8d",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-08-23T11:28:58.1806394+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5a155fa6-5803-4a18-b14f-e0bf3591c3db",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0d41f410-0af4-4728-a049-82d09210d1ef",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "d0b628ed-0f2e-4885-9b86-77da2f6d51a7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e08f87d6-035a-4624-8d78-2b0761d2c6d6"
},
"suggested_date_start": "2026-08-23T11:28:58.1806394+00:00",
"skill_id": "58c85d53-8379-449f-a912-0935e0860f3d",
"skill_code": "sample string 32",
"skill": {
"id": "fbc50531-ea94-42f8-bb12-cf6e62620ad3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7f477e00-fa8f-4662-ba0d-93a16d53946a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a611f152-4752-4e4a-9181-11bacc3bb74c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d421f9a-877f-4115-9d15-bdd6291ff556",
"db_currency_id": "405326c3-a2a4-4ad5-b579-5134aa3e4128",
"db_language_id": "1250d7a2-1abf-4d5c-955c-1647dae68b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "72ef9bae-ae95-4eae-bfc5-0c33f67530f2",
"date_reported_by_company": "2026-08-23T11:28:58.1806394+00:00",
"id2": 36,
"company_id": "e03859c5-bbe2-4c8f-8158-66511d9823ed",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "9529059e-4157-4c0d-973d-95ef0e2961a9",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
},
"work_instruction_details_id": "5309a6bb-35f9-45f6-a7cd-5f7389c83d75",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "05ae83ac-4467-4b94-a24b-64559f60788b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f13d78b7-aece-4b4f-ab8a-edf526a80ffe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-23T11:28:58.1806394+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "da5ce691-1638-43ed-afe9-38163a8fa255",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-23T11:28:58.1806394+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.