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": "346d3de5-c373-4ef5-a150-0e6020e29f31",
"jobs_id": "e3d068fc-9874-453b-9eed-552e4acfb3f1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4005328e-9085-4584-b310-24f261b1464f",
"_parent_id": "da262f72-7ab1-43f9-abac-b3973eff6985",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "31a19b61-1e44-4f78-b14e-02bacc080cc3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e4174635-c8f8-4170-b581-8c944e249a32",
"_parent_id": "a655fd50-5e75-451b-a099-55cc77d7478a",
"root_parent_id": "2d80dace-5b21-4885-9f59-3257abd5d79c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d82e7b94-dfd8-489e-a98c-81ddea845ef2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c5ed86de-4018-484c-b124-126fc0b9b9cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e3fd01c-b1b2-4c74-9468-f2f36ac19ccc",
"_parent_code": "sample string 6",
"sales_organization_id": "75bbd04b-bc04-4eab-8f45-4a6524aa46a7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"modified_dateutc": "2025-07-13T23:49:59.5674169+00:00"
},
"equipment_model_id": "a5f6c67a-7a77-4e27-9326-9fce038b406f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f0314195-2848-4915-9b33-8abce408e83b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "226e20fb-7f84-41f8-9be5-446ae4fc1d12",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6fcd53ff-c643-4fe3-982e-3087f31149cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ac0d6e64-6f1e-4d78-a565-e9497c6d9ebc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00"
},
"equipment_family_id": "9717feb1-f390-4eaa-8c90-f6f7d5206de7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c5ed86de-4018-484c-b124-126fc0b9b9cf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6e3fd01c-b1b2-4c74-9468-f2f36ac19ccc",
"_parent_code": "sample string 6",
"sales_organization_id": "75bbd04b-bc04-4eab-8f45-4a6524aa46a7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"modified_dateutc": "2025-07-13T23:49:59.5674169+00:00"
},
"date_in_production_since": "2025-07-13T23:49:59.5831692+00:00",
"date_out_of_production_since": "2025-07-13T23:49:59.5831692+00:00",
"date_end_support": "2025-07-13T23:49:59.5831692+00:00",
"sales_organization_id": "617ab8fd-9fef-4be7-9762-c85d56b79790",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+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-07-13T23:49:59.5831692+00:00"
},
"project_status_id": "5e3b8ff4-d1ef-42f3-9b0e-19fcd870aee6",
"project_status_code": "sample string 10",
"project_status": {
"id": "02ecb2d9-2da8-4d0c-a8d6-7ab5c7780c28",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9beafa15-211f-4878-be96-1b27ee906705",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00"
},
"company_id": "5b30c3e6-1817-4f05-af13-62241f95be24",
"company_code": "sample string 12",
"db_address_id": "17faa452-053a-4f2f-a00a-d1ef8728845c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d3f00768-e177-4d5e-b4eb-a14ecef0f9bb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "acae94c6-80dc-4909-8eb3-dac7a830a5d2",
"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-07-13T23:49:59.5831692+00:00",
"date_create": "2025-07-13T23:49:59.5831692+00:00",
"date_update": "2025-07-13T23:49:59.5831692+00:00",
"updated_by_user_id": "ed392b06-ced5-421a-be99-36307b0144af",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-13T23:49:59.5831692+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-13T23:49:59.5831692+00:00",
"date_last_job": "2025-07-13T23:49:59.5831692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-13T23:49:59.5831692+00:00",
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a48fd54-ef64-4413-be45-0d7737ea4f75",
"job_type_code": "sample string 7",
"job_type": {
"id": "d3aa7610-d89f-48c7-b99a-831bfcd775cb",
"name": "sample string 2",
"sales_organization_id": "8856aaed-0ef8-40b0-a7ff-434f88543551",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00",
"code": "sample string 7"
},
"job_priority_id": "ddcd32c9-d002-475e-8de6-7d8e7d4a68d4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "42402e79-0828-41a3-a2c9-a5e7d27d172a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "594eb80d-2c94-4af5-9417-1f2746dedb7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00"
},
"job_status_id": "d098578e-51f6-4ccc-a074-9cda57c2a4ca",
"job_status_code": "sample string 11",
"db_address_id": "c5dd2723-a859-4f30-aacf-14da61bffa13",
"contact_id": "fd1256c9-8358-4006-962f-79683cfb4c50",
"requested_by_company_id": "50798454-c574-49a7-ad53-1148dfc2f803",
"requested_by_contact_id": "ad9d5532-d522-4073-8635-f467de0b303e",
"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-07-13T23:49:59.5831692+00:00",
"due_date": "2025-07-13T23:49:59.5831692+00:00",
"date_create": "2025-07-13T23:49:59.5831692+00:00",
"date_update": "2025-07-13T23:49:59.5831692+00:00",
"date_closed": "2025-07-13T23:49:59.5831692+00:00",
"suggested_user_id": "5ac9fec6-9b13-4ab8-9845-8fbaac8d9e38",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7fe6f779-9fa6-47e4-af6f-a3908e69d338",
"db_language_id": "6fa441f4-6cbe-4918-9811-4c5870c54ddc",
"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-07-13T23:49:59.5831692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d9244ccb-a0d8-4d9d-85e1-ac501f5d2251",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a3ae0674-e765-4675-8aee-d3337648a925",
"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": "21e737a4-f084-49a1-8d30-2d74bca70010",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c9fadb09-72ad-4459-b085-d8ae4c4a1939"
},
"suggested_date_start": "2025-07-13T23:49:59.5831692+00:00",
"skill_id": "4b143512-9055-49f8-ad0d-b8e155a4169d",
"skill_code": "sample string 32",
"skill": {
"id": "121bf964-7243-4633-be8d-ccff855f7ce5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "68b858a7-a5d6-4184-a6cd-60b58a484f35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e84530b1-d1a7-4af4-92d0-51b10650060a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7ba8ce4-1f8a-47a0-82cc-654280dd2fcd",
"db_currency_id": "497f9b77-9129-4036-88d2-a1efb5d008c7",
"db_language_id": "ab24a848-2255-4f5e-8986-dd93af5b1972",
"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-07-13T23:49:59.5674169+00:00"
},
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "66e70e4e-764b-4323-a6cb-2d6375cab71f",
"date_reported_by_company": "2025-07-13T23:49:59.5831692+00:00",
"id2": 36,
"company_id": "db6ee225-96af-42ab-a5d9-776b1f468dbb",
"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": "eecf8c17-e6f3-45a6-acc2-cf34b61ee26d",
"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-07-13T23:49:59.5831692+00:00"
},
"work_instruction_details_id": "84296c82-62f0-4a8f-9ab5-8a07c692bd29",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a0f8a5dd-88ba-4872-9736-11eeaa892656",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a2dccb79-1f91-46c2-be57-0ac9f6c7e4c9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-13T23:49:59.5831692+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": "e71d1517-7db4-48fe-9a4d-adfdba3507d1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-13T23:49:59.5831692+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.