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": "0378fef1-91eb-4c85-babd-a3b16216eb46",
"jobs_id": "4ab537f4-b757-44a0-92bb-9ba014790179",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b941dfca-92e1-465c-8c83-c3fae3bb3d92",
"_parent_id": "d37fd4ee-6ffe-48dc-961a-ec67b00d806a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "911bfcfc-cc75-4142-9e9d-959132170264",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d92a830b-c179-4118-be47-87c8db034382",
"_parent_id": "c4bec3d9-b814-4e1f-87b8-eab9f7af23cf",
"root_parent_id": "189d3de9-f288-40d4-9eab-d169d920d26a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "119ddf00-6021-4d38-ac2f-16ee6db3fd65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a21da705-c77b-46cf-a4e5-82ce3805c9a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c4d296a-ec43-4993-a69f-27842957994f",
"_parent_code": "sample string 6",
"sales_organization_id": "9b088370-8d70-41f0-868a-5d3e1e0428b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"modified_dateutc": "2025-11-22T17:38:35.7030993+00:00"
},
"equipment_model_id": "5bc60189-be34-455b-b508-60550e06a2bb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d2b14916-f9a0-43cb-a773-f5c0e8b9e137",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e087c33c-7013-442f-81fa-1d75fef20049",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2d54cf78-801f-474d-88f7-cd4f63dbad98",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "357a58aa-0025-4d34-a520-e35dd31b6c38",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"modified_dateutc": "2025-11-22T17:38:35.7030993+00:00"
},
"equipment_family_id": "d271319d-b8b0-4a22-8baf-21a7d9c54044",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a21da705-c77b-46cf-a4e5-82ce3805c9a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1c4d296a-ec43-4993-a69f-27842957994f",
"_parent_code": "sample string 6",
"sales_organization_id": "9b088370-8d70-41f0-868a-5d3e1e0428b3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"modified_dateutc": "2025-11-22T17:38:35.7030993+00:00"
},
"date_in_production_since": "2025-11-22T17:38:35.7030993+00:00",
"date_out_of_production_since": "2025-11-22T17:38:35.7030993+00:00",
"date_end_support": "2025-11-22T17:38:35.7030993+00:00",
"sales_organization_id": "497ad4bb-7215-468c-8693-2c0346c9dbc0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+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-11-22T17:38:35.718741+00:00"
},
"project_status_id": "a6bf8472-3737-41e5-b96f-14099e4ffdc0",
"project_status_code": "sample string 10",
"project_status": {
"id": "77732004-8e41-45ad-9e7a-375f9926d613",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7d56546c-931d-420d-bc28-3a17de1081c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00"
},
"company_id": "d86e5f6c-71c8-4267-9553-655bad54f80a",
"company_code": "sample string 12",
"db_address_id": "ae2c3b4d-48fa-412b-806e-689f697e12c4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9596ed4c-282c-44fa-8e12-95749334b884",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "10f30fcf-564c-453e-a8c6-ea3636155df1",
"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-11-22T17:38:35.718741+00:00",
"date_create": "2025-11-22T17:38:35.718741+00:00",
"date_update": "2025-11-22T17:38:35.718741+00:00",
"updated_by_user_id": "29a92d66-7238-4fd2-990d-4566d0118078",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-22T17:38:35.718741+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-11-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-22T17:38:35.718741+00:00",
"date_last_job": "2025-11-22T17:38:35.718741+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-22T17:38:35.718741+00:00",
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00",
"is_mobile_installation": true
},
"job_type_id": "43e4c938-3b38-4966-935d-a5435a413e48",
"job_type_code": "sample string 7",
"job_type": {
"id": "974035ad-2ffb-42f6-9d83-6ead04e74660",
"name": "sample string 2",
"sales_organization_id": "4630d545-3a01-4cce-9105-f63bfc88f513",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00",
"code": "sample string 7"
},
"job_priority_id": "13b5235f-5c54-4837-8f35-f8b51eb28ece",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4a8bd0f0-7992-41c9-b416-b20955eeeae1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "018705d1-6013-4672-8a44-516c0a786576",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00"
},
"job_status_id": "ad8f0929-5412-4960-8872-598d6cef77eb",
"job_status_code": "sample string 11",
"db_address_id": "fd05e3bf-6fb2-4cb8-9fd3-e129d31c5290",
"contact_id": "e025ba18-ef4a-452b-b8c7-5444ab242529",
"requested_by_company_id": "50343a70-0203-4ef3-9c50-60979994a3d7",
"requested_by_contact_id": "a98279e4-ae25-4112-9293-fc3eaa2cd50c",
"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-11-22T17:38:35.718741+00:00",
"due_date": "2025-11-22T17:38:35.718741+00:00",
"date_create": "2025-11-22T17:38:35.718741+00:00",
"date_update": "2025-11-22T17:38:35.718741+00:00",
"date_closed": "2025-11-22T17:38:35.718741+00:00",
"suggested_user_id": "4d6ec81f-0d13-49c8-a0fb-7052f05ec24a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c00cdc1e-dfd2-48af-aba1-0b1b3acf28a8",
"db_language_id": "61246f1d-d438-49b2-b70c-ecdd0aedb8e6",
"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-11-22T17:38:35.718741+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "194c2bf3-b4a1-44a1-9f3b-f44435020d9a",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2b56da92-5f5c-4344-a48f-5af480b2f5f1",
"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": "8195870a-6231-4d75-9255-cef37229808e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3ab7a66a-e989-48ad-840c-b6149ec8b1ca"
},
"suggested_date_start": "2025-11-22T17:38:35.718741+00:00",
"skill_id": "9e94b752-ee3f-41f5-9ec8-e143d1bc71a8",
"skill_code": "sample string 32",
"skill": {
"id": "2b86ae7b-82f7-4ce7-ae95-4cedbdff4d39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cfaaea66-e5b3-4915-a5f6-edbda267c309",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d01fe33-7fac-4657-a0b7-d850891b79c5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7981e9f1-830e-400b-a5b3-bfb7d019bc5e",
"db_currency_id": "6f6cf9c5-ff2b-4b9b-8465-0f4d4b8f5495",
"db_language_id": "b5fcc175-e9f1-4aee-99d9-31d19d252af0",
"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-11-22T17:38:35.7030993+00:00"
},
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "09f56b96-9d4b-4593-8a0a-6cda82c753f3",
"date_reported_by_company": "2025-11-22T17:38:35.718741+00:00",
"id2": 36,
"company_id": "17a885e1-67d8-43c1-b270-0cf2b08d2329",
"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": "9dd30ff9-cbae-4d6f-bcbe-60d2212bbd98",
"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-11-22T17:38:35.718741+00:00"
},
"work_instruction_details_id": "676e16c3-040f-45f6-ae02-2d83b316586c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1a5bb205-f84a-4cd0-9149-173cd6e4c8f9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "861d73de-8266-435b-9b78-866d12b82e21",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-22T17:38:35.718741+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": "d53a3664-328e-4675-9505-560972f51107",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-22T17:38:35.718741+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.