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": "c13893f1-cf16-450f-97a0-a143c0e380e0",
"jobs_id": "2b5f709b-a598-4b86-944a-c807b1b8a2b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "123c5060-88cb-4ab9-b929-5754140675cf",
"_parent_id": "f6dd3554-ac8c-4121-afea-2f89f2a9b074",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "96c951fd-f99f-4118-9e2e-1976d7bb70cb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f0c24dd4-caff-4ac7-af04-528cbbc5c9f3",
"_parent_id": "71ceeaaa-4e15-4e7b-afdb-6c23205b2f15",
"root_parent_id": "faf256ab-068a-4c85-a834-e4d44f9c70eb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "18813e04-14c4-446f-b42d-34f39b1f2941",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "60c19ed5-afd1-4a48-b9c1-3c0a65d461dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1cb10f2e-52ba-4755-830f-df614e98b47f",
"_parent_code": "sample string 6",
"sales_organization_id": "149ed0ae-8224-4c3a-ba88-5a99176a6a25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00"
},
"equipment_model_id": "bf97f709-691b-498e-975e-b437cf305c33",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4409681e-0faa-472b-9ee1-4bbac9f1f24c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5a083d28-7c14-4686-8073-2975b1bbcfd8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "57973b28-47a8-4297-9cfb-8e461ec79514",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e7420367-a02f-457d-b8cb-4e92e3e17c58",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00"
},
"equipment_family_id": "0d2a1645-c007-4dc2-9d72-1596c93b0463",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "60c19ed5-afd1-4a48-b9c1-3c0a65d461dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1cb10f2e-52ba-4755-830f-df614e98b47f",
"_parent_code": "sample string 6",
"sales_organization_id": "149ed0ae-8224-4c3a-ba88-5a99176a6a25",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00"
},
"date_in_production_since": "2026-02-03T15:31:05.7219932+00:00",
"date_out_of_production_since": "2026-02-03T15:31:05.7219932+00:00",
"date_end_support": "2026-02-03T15:31:05.7219932+00:00",
"sales_organization_id": "a64a00c4-34b5-4217-9b67-afae30b7dc6b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+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-02-03T15:31:05.7219932+00:00"
},
"project_status_id": "7fbde2e2-12dc-44b0-9f7c-f1df800cd977",
"project_status_code": "sample string 10",
"project_status": {
"id": "d5493082-b167-46ab-9d94-d83aefdd6458",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0610d3e8-a1ed-4e94-8f81-e2114fb06fc2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00"
},
"company_id": "d596623e-a8b7-4016-9c29-6ee4f39119c2",
"company_code": "sample string 12",
"db_address_id": "e6165eab-3063-4ce2-8ea1-85f8c71bb711",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "afcea996-4189-4173-87bc-7f10f376707c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bcfa2f7e-1a51-45d7-bb30-927e16365317",
"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-02-03T15:31:05.7219932+00:00",
"date_create": "2026-02-03T15:31:05.7219932+00:00",
"date_update": "2026-02-03T15:31:05.7219932+00:00",
"updated_by_user_id": "fee42635-b3e6-4791-9a39-989f83a7f109",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-03T15:31:05.7219932+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-02-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-03T15:31:05.7219932+00:00",
"date_last_job": "2026-02-03T15:31:05.7219932+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-03T15:31:05.7219932+00:00",
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00",
"is_mobile_installation": true
},
"job_type_id": "56697d05-622b-4245-a5de-c3e65a08c6c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "9dab5a3e-4b84-49a7-b91e-01a6be54eab9",
"name": "sample string 2",
"sales_organization_id": "5ac115e5-7388-4f26-a004-6829660d3dbd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00",
"code": "sample string 7"
},
"job_priority_id": "8e5272fb-2603-4453-8c03-3935a556878f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8e333a4d-5ca7-4705-b7d8-64b7f12d5e16",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2c83ef3e-386a-42df-910e-d47326a5695b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-03T15:31:05.7219932+00:00"
},
"job_status_id": "e472f8a2-8f7f-470d-aac9-cca3db4d8e55",
"job_status_code": "sample string 11",
"db_address_id": "bbb5457d-4918-4dc3-8a77-96d0022801f0",
"contact_id": "9e2e25fa-01a2-4437-b7b5-21c1794d9571",
"requested_by_company_id": "baf4053e-6d4f-4d8d-bdef-b3dafbdf78fb",
"requested_by_contact_id": "7722850c-159a-488c-8287-b9f86b12b7bd",
"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-02-03T15:31:05.7219932+00:00",
"due_date": "2026-02-03T15:31:05.7219932+00:00",
"date_create": "2026-02-03T15:31:05.7219932+00:00",
"date_update": "2026-02-03T15:31:05.7219932+00:00",
"date_closed": "2026-02-03T15:31:05.7219932+00:00",
"suggested_user_id": "a63f1837-1b78-4a1e-994c-26a866bca695",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bfd7fb14-f6a7-4f83-ad7a-4ef7036f5915",
"db_language_id": "867a340e-f85c-4dfd-9c9d-2670ea2f2887",
"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-02-03T15:31:05.7219932+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7258ad2b-9b6a-44eb-93ae-1321a7530ec1",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8b981d52-94ee-4bfe-a299-40cc071aa274",
"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": "d94e42dd-90af-4295-81bf-c5f356d64b6b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-03T15:31:05.7376165+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "73deebf9-6de4-4a26-a7d4-b0851150f181"
},
"suggested_date_start": "2026-02-03T15:31:05.7376165+00:00",
"skill_id": "c0e3d635-b8d1-4e69-a882-31c0a14a195e",
"skill_code": "sample string 32",
"skill": {
"id": "e75e95f0-14f9-4f18-8075-a6b103421b10",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e0e52e91-7b60-4258-a1a0-23e10dc7443a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04369c7b-044e-44d5-b94e-a190635f1908",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "baa031be-3e2e-4c1f-b894-d78077dea869",
"db_currency_id": "b90d7c24-48e6-438c-af54-b40eed694101",
"db_language_id": "f9a540bb-7312-4123-b8a1-3cf6b81c63d0",
"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-02-03T15:31:05.7219932+00:00"
},
"modified_dateutc": "2026-02-03T15:31:05.7376165+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "65275044-68b3-4d32-8e82-4bd13922ef1c",
"date_reported_by_company": "2026-02-03T15:31:05.7376165+00:00",
"id2": 36,
"company_id": "e531621c-ed38-4446-b8b1-68c7f3906095",
"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": "c432b6e3-2851-4d05-bf8b-8a0bb3eafa0b",
"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-02-03T15:31:05.7376165+00:00"
},
"work_instruction_details_id": "6286c31e-0459-4c31-880d-7fc9105cd2ce",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bb2ad237-ef63-4a2c-bfd3-e2da473855af",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2ae239b6-397a-46a0-bed2-8fdede76e2dc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-03T15:31:05.7376165+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": "fc329595-d228-447b-a577-a0fdf12bfac9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-03T15:31:05.7376165+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.