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": "078e4e35-2e3c-4ced-8051-4105bdc0b004",
"jobs_id": "9062855f-af19-4738-b695-df1b930987c7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b67272b3-1704-4d54-93c0-dceed69fadd2",
"_parent_id": "f0d6b750-a12c-457e-8bf7-e4ce104b9650",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "be1114ab-4676-4ebb-9020-2875efd496db",
"project_reference_back_office": "sample string 5",
"project": {
"id": "102e927a-c270-49f2-a810-e2ef8a5b3ba7",
"_parent_id": "2e6aedc1-555d-4fe6-b922-7f2d671e1023",
"root_parent_id": "eda879e4-cf5d-4197-b6f6-a38b198fc2b2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7760ab9d-f217-4d91-9ed0-7080dbd0f9f2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "060f2196-56af-4973-ab2c-be70e2f17b4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88fb272b-c56e-46d6-8a2d-05ac8a612e39",
"_parent_code": "sample string 6",
"sales_organization_id": "c08b4a75-30dc-4ed7-98cd-bc59dd5500ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"equipment_model_id": "1a6df254-71ce-45ac-9dd9-dea41da11590",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ff82d45f-f81f-4319-9abe-01d7ae538630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "83915ceb-2ec8-4c49-a59e-56a341a823ac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7c6c024-4461-4232-a07f-486bcc8a40b4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "67774c5f-2f90-4827-b723-fcb538c6b7cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"equipment_family_id": "c084897d-f238-49e3-9f6c-05c32a500760",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "060f2196-56af-4973-ab2c-be70e2f17b4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "88fb272b-c56e-46d6-8a2d-05ac8a612e39",
"_parent_code": "sample string 6",
"sales_organization_id": "c08b4a75-30dc-4ed7-98cd-bc59dd5500ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"date_in_production_since": "2026-04-18T11:23:15.3715785+00:00",
"date_out_of_production_since": "2026-04-18T11:23:15.3715785+00:00",
"date_end_support": "2026-04-18T11:23:15.3715785+00:00",
"sales_organization_id": "be10a801-03d6-4eda-83f3-cbb3f6d01050",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+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-04-18T11:23:15.3715785+00:00"
},
"project_status_id": "c5dd97b0-5009-40c2-8802-26b31e7fe396",
"project_status_code": "sample string 10",
"project_status": {
"id": "6c9ccff5-07a0-4311-84ff-b9df816a0f69",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4ec2d037-0e27-4fc4-96e6-8d6ddc136c94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"company_id": "305ab115-1668-4780-894c-2d5eb902b2ae",
"company_code": "sample string 12",
"db_address_id": "1bbc6853-c687-4c11-b4d5-dc86ecc4afbf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b909c9e5-9caa-45d5-be30-81de0366573d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "95153875-e8c5-4828-a263-2770b5253851",
"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-04-18T11:23:15.3715785+00:00",
"date_create": "2026-04-18T11:23:15.3715785+00:00",
"date_update": "2026-04-18T11:23:15.3715785+00:00",
"updated_by_user_id": "b43ffae5-3b6d-42fe-aec5-44ca18ec2fe7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T11:23:15.3715785+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-04-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T11:23:15.3715785+00:00",
"date_last_job": "2026-04-18T11:23:15.3715785+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T11:23:15.3715785+00:00",
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00",
"is_mobile_installation": true
},
"job_type_id": "6e502370-a46e-4da7-a52a-83196e059e90",
"job_type_code": "sample string 7",
"job_type": {
"id": "172c0561-6836-441e-87e6-07ddf00156f7",
"name": "sample string 2",
"sales_organization_id": "268c1c05-23e5-42b1-be11-11aae4dd1550",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00",
"code": "sample string 7"
},
"job_priority_id": "bb3017e4-6661-4148-8fc2-840e67c0ba76",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c106ecd6-1ffd-412c-ab9a-b251fc4a6daf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e07c4f07-c4c5-4dd4-89bf-a00fd1ea69df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"job_status_id": "4f84ffe4-046f-4108-a0e6-8d7110db33d8",
"job_status_code": "sample string 11",
"db_address_id": "4820bde8-d896-4083-96a6-8a8aa607109a",
"contact_id": "c799cace-c3c3-418e-af01-beed4ca68540",
"requested_by_company_id": "02446923-2d96-41a7-80ec-d379711d1e3b",
"requested_by_contact_id": "33f8d3ea-23c3-4e44-8a9d-35b0f1c6ffb7",
"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-04-18T11:23:15.3715785+00:00",
"due_date": "2026-04-18T11:23:15.3715785+00:00",
"date_create": "2026-04-18T11:23:15.3715785+00:00",
"date_update": "2026-04-18T11:23:15.3715785+00:00",
"date_closed": "2026-04-18T11:23:15.3715785+00:00",
"suggested_user_id": "07e918b0-cbda-49c1-abd2-4adfce066060",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0713f66f-5f9b-468f-b06f-1cf5ae959014",
"db_language_id": "c3d8b5ec-f3b2-4e27-82e6-73998875a2eb",
"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-04-18T11:23:15.3715785+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8e097311-a07a-444b-b006-af3a79991349",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e86c4c28-3fe1-42a0-b198-7da65cc20afb",
"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": "548e3667-3df9-404f-9652-d63dfb067ac9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6155bdac-8552-41b8-b498-233a399a8f23"
},
"suggested_date_start": "2026-04-18T11:23:15.3715785+00:00",
"skill_id": "1ab2326f-3297-4c83-aa84-d8bfea45caff",
"skill_code": "sample string 32",
"skill": {
"id": "bacd706c-aab4-4413-85a5-4eed2c95df4c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c85e682b-b4df-4669-8bec-597d48ffd6db",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "082170f9-1f39-45e7-8f3c-444090f68248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c32c26-e932-4691-9b04-955e662de088",
"db_currency_id": "273ad60a-1a58-4d86-b2e2-3c715549c09c",
"db_language_id": "a04669dc-133e-440e-8a29-713f0f319440",
"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-04-18T11:23:15.3715785+00:00"
},
"modified_dateutc": "2026-04-18T11:23:15.3715785+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d2e687b4-c68c-490a-b6ee-bde62d864775",
"date_reported_by_company": "2026-04-18T11:23:15.3715785+00:00",
"id2": 36,
"company_id": "a1d94ed5-2f88-45d7-a59e-52b867b98786",
"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": "6b9be620-ad2a-4ee5-8548-4a87623df95e",
"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-04-18T11:23:15.3872023+00:00"
},
"work_instruction_details_id": "8178eda1-4e09-414a-9b35-8b8b06ecc907",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fb292412-d272-4d0e-b1b4-3f3897ad4572",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9b63e51d-a69b-440e-86f0-4baeec4190f0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T11:23:15.3872023+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": "02c7d515-9d6b-4556-bb06-c62a6aefc713",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T11:23:15.3872023+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.