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": "3aa24095-7622-4029-99bb-728c07afb129",
"jobs_id": "4878e63d-6893-4a4a-94f4-98ce70c0aedd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "64684f74-437f-406e-a948-b5d3191ce837",
"_parent_id": "01de83c8-592f-46aa-b500-b8c9de5689a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0da5aff7-fdd0-4364-817a-d2c30c8793c0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "99c04a62-4fac-4147-a2cd-d11a3b2d4173",
"_parent_id": "bd0a1301-1600-4d22-a568-eb440e135b51",
"root_parent_id": "ee71f39c-f0c1-4231-b005-aeb56b55946b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5c5ee019-73f8-47a2-a520-64e4b2a853d7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "44cbda0f-73ee-445b-9315-96e81c237928",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eae2124c-013e-4ae3-9a0a-b1f434fd4fc2",
"_parent_code": "sample string 6",
"sales_organization_id": "dba8622d-7431-45d4-90bc-0edbada40ee5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"equipment_model_id": "2f1e3235-3912-4dbd-878c-dfd12ccb83d8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af4e093e-d427-41af-98cf-b07aaea98666",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "66153053-82cf-41cb-8452-cc8ac923390f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9b6384d1-046d-40b4-b02a-d0d72f815648",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "66a6aa08-010d-44e6-bcd6-cd23d2a24a1f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"equipment_family_id": "01c6f986-6e34-4c6b-b6a2-56e52852f459",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "44cbda0f-73ee-445b-9315-96e81c237928",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eae2124c-013e-4ae3-9a0a-b1f434fd4fc2",
"_parent_code": "sample string 6",
"sales_organization_id": "dba8622d-7431-45d4-90bc-0edbada40ee5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"date_in_production_since": "2026-09-16T15:16:39.9774013+00:00",
"date_out_of_production_since": "2026-09-16T15:16:39.9774013+00:00",
"date_end_support": "2026-09-16T15:16:39.9774013+00:00",
"sales_organization_id": "7001d750-69d2-41bc-b289-a92f37e09f34",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+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-09-16T15:16:39.9774013+00:00"
},
"project_status_id": "199e046f-0b73-4c4e-a86f-9226fdcf5443",
"project_status_code": "sample string 10",
"project_status": {
"id": "ead2358a-319c-4eb6-8485-a17b8fc70456",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ccc0e63f-c942-4c95-b8b3-7a87dd6c3f61",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"company_id": "cea73c79-b101-4c69-b1aa-16b004c10994",
"company_code": "sample string 12",
"db_address_id": "cdbdb4f5-148b-4c18-a24a-58c40dbfd8c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "618b5d00-e554-4789-8f60-e095bc1fd741",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "35ba65b5-ee3c-4181-8ec6-d049dfae2876",
"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-09-16T15:16:39.9774013+00:00",
"date_create": "2026-09-16T15:16:39.9774013+00:00",
"date_update": "2026-09-16T15:16:39.9774013+00:00",
"updated_by_user_id": "db088502-77bc-48e8-8a06-f41d3c016ee4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-16T15:16:39.9774013+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-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-16T15:16:39.9774013+00:00",
"date_last_job": "2026-09-16T15:16:39.9774013+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-16T15:16:39.9774013+00:00",
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00",
"is_mobile_installation": true
},
"job_type_id": "e7ce5f07-1715-4ec7-b12d-185c6a12ae64",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e5d29e0-83e6-4c4e-800e-f57bd98abf27",
"name": "sample string 2",
"sales_organization_id": "30e2307c-aab3-4656-b6fe-0413d74f8a55",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00",
"code": "sample string 7"
},
"job_priority_id": "a7f3969a-0eaa-4b75-9fe6-cc569a07ab12",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7042e54f-abbe-4e00-9ddb-376f04e0f24b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7e2073ae-e9ea-45cf-b6f9-168a5d0ae7c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"job_status_id": "be3f912a-421c-4408-bf99-6a54585cb4af",
"job_status_code": "sample string 11",
"db_address_id": "ed561c3a-04c7-410b-8a51-abd2d5af820c",
"contact_id": "ca1d4112-f291-494b-b307-dc10224453ff",
"requested_by_company_id": "a5cd8cc9-0fdc-499c-b1ce-462726a0ce43",
"requested_by_contact_id": "3544bdba-47e9-46bb-b96d-463d7db09ffb",
"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-09-16T15:16:39.9774013+00:00",
"due_date": "2026-09-16T15:16:39.9774013+00:00",
"date_create": "2026-09-16T15:16:39.9774013+00:00",
"date_update": "2026-09-16T15:16:39.9774013+00:00",
"date_closed": "2026-09-16T15:16:39.9774013+00:00",
"suggested_user_id": "3fd88bf0-3857-4c5c-8287-3b090864b28b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4027581d-bf28-4277-bd87-007f20460705",
"db_language_id": "b89ae1e3-5833-49df-bda4-df438094891b",
"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-09-16T15:16:39.9774013+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9987bd10-c0cd-46c9-9c89-0491d8265074",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b79225ec-8ff4-456d-8a65-7afdfbbfe4d6",
"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": "0a9a3d1d-f79a-4141-8fc0-4d2455fb9b1a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4a6cbfca-7562-4256-8e9d-170316d989af"
},
"suggested_date_start": "2026-09-16T15:16:39.9774013+00:00",
"skill_id": "ddb95c21-e17e-425c-b976-0165f38c5148",
"skill_code": "sample string 32",
"skill": {
"id": "a202269f-ed04-40ee-b695-ede1bc948c41",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "28de4ce9-d6f2-491c-a6a1-5603a2762835",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3d3c61e-a2d5-4c9a-8669-7a96aa3b73cd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d2899965-60c1-4e02-a1bc-76894b5b8f82",
"db_currency_id": "bd2cd519-fbd1-478d-a18f-4297eb14398c",
"db_language_id": "77f67187-2d18-4506-a284-cb150c13f7b8",
"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-09-16T15:16:39.9774013+00:00"
},
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c2bd9414-192f-40f9-bfff-2c1cae8526ba",
"date_reported_by_company": "2026-09-16T15:16:39.9774013+00:00",
"id2": 36,
"company_id": "668f92ec-729a-4963-a128-caa360cf8d02",
"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": "ce63600d-e01c-4d98-9cb6-8dfbbda5b939",
"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-09-16T15:16:39.9774013+00:00"
},
"work_instruction_details_id": "f965c5e6-fd45-474c-b7f7-95ae6bbd5954",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a0bb2de9-3690-4852-bfa2-f92de70ea1a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "938d5666-52bb-42dd-a73d-a62a51c06535",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-16T15:16:39.9774013+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": "ead9e841-ad81-4046-bc6c-09181265aa51",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-16T15:16:39.9774013+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.