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": "0ec42dc7-ce49-484a-96d4-d90eab06deef",
"jobs_id": "1a7b6555-d4e9-4047-8019-fd01248a5b4f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c58f9e6-e25b-4d8a-9b9a-02317034bc3e",
"_parent_id": "e32216d7-d5ec-4608-86b1-7af67b996a03",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3171ac95-8d18-46ba-890e-785276e94525",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa8ebb1b-af3a-4827-9703-d5db76dc8484",
"_parent_id": "bbf5e885-e447-409f-ab92-39f41aacf9da",
"root_parent_id": "279aada6-a260-4ed2-8e79-84f9706f2325",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5ba0737f-cfe8-4c57-b8d8-c4478f842bad",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "624d772c-cc61-4bb4-9337-4808202d3d0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e7cdbcbd-2b5a-4e34-a2a3-b55e2952519d",
"_parent_code": "sample string 6",
"sales_organization_id": "173b8a28-e4a7-4550-a92b-b34eb3bf35ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"equipment_model_id": "acca4cca-9f63-4bdc-95d9-257f1912f35c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "512b12af-cace-44e1-be09-3ac8fd42399f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cbfd7685-721c-44fd-aff6-36ca4a56feeb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3fe3bb5-e4c9-4df3-8b5a-a4f5b96d1fbc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "65865683-9ee5-452e-9a43-1803f6209092",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"equipment_family_id": "06c4a467-6ca4-4a04-a7dd-f88bc9e6fe77",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "624d772c-cc61-4bb4-9337-4808202d3d0a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e7cdbcbd-2b5a-4e34-a2a3-b55e2952519d",
"_parent_code": "sample string 6",
"sales_organization_id": "173b8a28-e4a7-4550-a92b-b34eb3bf35ee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"date_in_production_since": "2025-10-10T06:10:40.8109658+00:00",
"date_out_of_production_since": "2025-10-10T06:10:40.8109658+00:00",
"date_end_support": "2025-10-10T06:10:40.8109658+00:00",
"sales_organization_id": "4205d018-69c0-4078-aba7-6cba26b2fe2b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+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": "2025-10-10T06:10:40.8109658+00:00"
},
"project_status_id": "bdb7a417-a5c2-4d86-9f4f-7051e356e054",
"project_status_code": "sample string 10",
"project_status": {
"id": "d5ebac64-0c68-4ac1-90f9-e38ca9379fb6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a4693d04-6c91-43f9-b8aa-1f922a1bc98f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"company_id": "dd9a805c-db8a-45ed-977d-0658d83439b9",
"company_code": "sample string 12",
"db_address_id": "f28a69f9-a9d6-429d-821a-96fcbb2ee29a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82e6555f-879b-4f82-bee8-3588c2f69be5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "db346bc8-b903-4725-b50b-699558235d8c",
"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": "2025-10-10T06:10:40.8109658+00:00",
"date_create": "2025-10-10T06:10:40.8109658+00:00",
"date_update": "2025-10-10T06:10:40.8109658+00:00",
"updated_by_user_id": "47e1a371-a359-4e19-b6cc-de1e2683fdd7",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-10T06:10:40.8109658+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": "2025-10-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-10T06:10:40.8109658+00:00",
"date_last_job": "2025-10-10T06:10:40.8109658+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-10T06:10:40.8109658+00:00",
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00",
"is_mobile_installation": true
},
"job_type_id": "a24e32a8-39da-4b73-8b7e-ff0ad650229d",
"job_type_code": "sample string 7",
"job_type": {
"id": "175ae9f1-02dc-4f85-bf5a-0e906f1a2dda",
"name": "sample string 2",
"sales_organization_id": "fe8bf586-9347-4514-a7df-31c538c58448",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00",
"code": "sample string 7"
},
"job_priority_id": "179918c1-4f30-47f1-aaf4-c65e45147bc2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "136a1077-2bb3-48c1-a91d-75d22b2adfa2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1797128e-b954-4e8e-a378-785bd62a805c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"job_status_id": "0d86ec73-6252-4c31-ae1d-18821fd29a58",
"job_status_code": "sample string 11",
"db_address_id": "186dc3da-bdb0-4f3b-8abe-4b889882c96b",
"contact_id": "00363f26-e5a4-46a4-a848-18dcf3fca750",
"requested_by_company_id": "5da9ab3b-56eb-49db-b8d8-0998b458e9e9",
"requested_by_contact_id": "8dc167ff-3d87-4eea-9f48-55fb172509fe",
"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": "2025-10-10T06:10:40.8109658+00:00",
"due_date": "2025-10-10T06:10:40.8109658+00:00",
"date_create": "2025-10-10T06:10:40.8109658+00:00",
"date_update": "2025-10-10T06:10:40.8109658+00:00",
"date_closed": "2025-10-10T06:10:40.8109658+00:00",
"suggested_user_id": "fa1ae68d-76c4-4a6d-ac1c-fa095cb0e61e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b460a4b4-fcb3-4a5c-8818-2e380e830d3e",
"db_language_id": "54fc3f7e-9fc5-44aa-bda4-e28d620d3bda",
"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": "2025-10-10T06:10:40.8109658+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6a14d937-8621-4b24-8c60-d9c57a84b143",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b17d9e84-4afe-4b63-805d-5ccea9d50fe9",
"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": "bbed05c6-199e-472a-b814-2d952482eb7c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "853a8ab3-e8de-4e7b-856f-fd4513d4ac65"
},
"suggested_date_start": "2025-10-10T06:10:40.8109658+00:00",
"skill_id": "5c5d9668-7d34-4970-9aa3-5f8f0d7358c7",
"skill_code": "sample string 32",
"skill": {
"id": "523c7b75-bd36-4b0c-bbd3-49e79f07fdbe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0de8e7f3-d397-43bc-8ab7-dd156c850295",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c059b16-9888-4b64-8a34-93c4bfbdbc1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "126ef07d-e855-4bce-a1d3-67fd87ae8f71",
"db_currency_id": "9ad8ec2d-eb1a-490e-882f-ac9f30138b81",
"db_language_id": "3dc55003-ee2d-432b-ad28-2d0548a6c66b",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9feda73c-8d74-4e3e-8497-71bf917af7e0",
"date_reported_by_company": "2025-10-10T06:10:40.8109658+00:00",
"id2": 36,
"company_id": "091913bc-985d-4b13-81f9-da7b8adaeeca",
"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": "daf4f55b-5ef6-483f-8096-5be644454984",
"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": "2025-10-10T06:10:40.8109658+00:00"
},
"work_instruction_details_id": "ee93f52a-3528-41f2-a409-376a84e95ecf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f53e8d38-18fa-4638-b2e6-71291f80fcfd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "64fd3d12-4610-4c39-8b9e-1d04641ebfc2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-10T06:10:40.8109658+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": "3de48e77-c1b5-403b-8527-d0bf07cd6116",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-10T06:10:40.8109658+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.