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": "495c0688-5d81-434e-b06a-0694e1d8ad1a",
"jobs_id": "46ac5d9f-e587-4b48-841b-d4e4bf6f36f6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "58c6d05b-2acb-4671-be0e-b40882378674",
"_parent_id": "07f3fb2d-72dd-49bb-8302-d71edfecd64c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2dab2957-d989-4969-ac62-e7a6031239b1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "25262b88-794d-40ec-be22-329ec1435079",
"_parent_id": "35e8690e-32e8-4fda-b1b5-69e387f9751d",
"root_parent_id": "836d9152-0e63-4af8-8f0a-c770be079ef8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a645b246-4ab0-479d-aabb-d65e17777e75",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "868986e2-ac44-457d-9e8b-cee29e8ad5a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83e76e0d-d632-4628-acbe-211060178af5",
"_parent_code": "sample string 6",
"sales_organization_id": "f0bfe9ae-a903-4945-85bd-405a682c5fef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"equipment_model_id": "795f97f4-8a92-4957-a17d-49266c65f5f5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "88285f2b-1fb7-49f7-837c-f4438e3aa71d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "56129f9a-772f-439d-9079-83b5e286aaa1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3e510f33-6f07-49c4-8287-36b51919565f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "90e74dbb-1a31-4a9c-b37c-80983a6125e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"equipment_family_id": "f362d953-ae47-4e15-9dc3-cfde43c37201",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "868986e2-ac44-457d-9e8b-cee29e8ad5a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83e76e0d-d632-4628-acbe-211060178af5",
"_parent_code": "sample string 6",
"sales_organization_id": "f0bfe9ae-a903-4945-85bd-405a682c5fef",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"date_in_production_since": "2025-11-30T14:15:38.512491+00:00",
"date_out_of_production_since": "2025-11-30T14:15:38.512491+00:00",
"date_end_support": "2025-11-30T14:15:38.512491+00:00",
"sales_organization_id": "1b6c2e94-aa76-4f00-bd4c-b8c673e5898c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+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-30T14:15:38.512491+00:00"
},
"project_status_id": "f7efbf49-dede-4d8a-b0dd-3357f01201ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "995d5c4c-90da-48dd-85bd-7babd55ddc32",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4f9e7b79-4365-4045-bcc2-935b58c7a7d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"company_id": "2c467d63-9b01-4745-9385-40dec46e8712",
"company_code": "sample string 12",
"db_address_id": "13948e4d-fcf3-4b32-8609-6a581f35da53",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "278ed6a4-ab85-4fd2-ac79-7d4cf8a74c91",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90f1422d-8643-40fc-949a-1facbe5ff8ab",
"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-30T14:15:38.512491+00:00",
"date_create": "2025-11-30T14:15:38.512491+00:00",
"date_update": "2025-11-30T14:15:38.512491+00:00",
"updated_by_user_id": "6a45d698-9a00-4e77-b381-cba6a54736c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-30T14:15:38.512491+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-30T14:15:38.512491+00:00",
"date_last_job": "2025-11-30T14:15:38.512491+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-30T14:15:38.512491+00:00",
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00",
"is_mobile_installation": true
},
"job_type_id": "b0bee88a-89be-45d4-a41f-2a3c406e3309",
"job_type_code": "sample string 7",
"job_type": {
"id": "de113a40-b6c9-44ee-91b9-292c643d37ed",
"name": "sample string 2",
"sales_organization_id": "f8a7e807-15b5-4ec9-8a67-560412f7a821",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b41f5cb-e7b2-4f52-9206-4a69e09f0e6f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a2aef61-2b08-4c53-b630-d8754040ac4a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8baaabc9-cb79-4275-a1a1-7bc2080ac799",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"job_status_id": "d5383373-3b58-4f18-a483-33b6537e9549",
"job_status_code": "sample string 11",
"db_address_id": "ee4fdf38-b5a8-4440-8cd7-85a59340a3f2",
"contact_id": "d437e20a-17f2-47d3-8ffc-7a52646bd57e",
"requested_by_company_id": "6c5f4b86-ebaa-4abc-a0b3-91cc95e076c8",
"requested_by_contact_id": "fff0fc07-0778-426c-b019-15583b65c6fc",
"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-30T14:15:38.512491+00:00",
"due_date": "2025-11-30T14:15:38.512491+00:00",
"date_create": "2025-11-30T14:15:38.512491+00:00",
"date_update": "2025-11-30T14:15:38.512491+00:00",
"date_closed": "2025-11-30T14:15:38.512491+00:00",
"suggested_user_id": "0016c5ee-b820-4b99-858c-1f9a762e0bc5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8011c0da-a6c1-490e-9f3a-34b5b2d7bbf1",
"db_language_id": "dbc5513a-0121-49f2-82d2-4eff12d705bb",
"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-30T14:15:38.512491+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "61c0ed46-caa9-4b5a-8962-6fd2da5bd676",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a70aa137-eaa1-4567-966b-edca94d5c730",
"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": "587beecc-a9f9-4dbb-bf84-acb299569b3f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7a7cb3de-7e3c-4ee4-b539-2f880028e17c"
},
"suggested_date_start": "2025-11-30T14:15:38.512491+00:00",
"skill_id": "231e7055-63bc-42fb-8d22-26cf718d00b5",
"skill_code": "sample string 32",
"skill": {
"id": "b4c63b2f-435c-4434-bbd0-a29909fc6dfa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "737ed7a5-7095-4579-acaa-637194d5884e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61c0ab27-cbc0-4b13-b59d-3116357d494f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ffc2362f-a11d-4f9a-9925-483fba81ab91",
"db_currency_id": "5909c719-f91a-44e3-a370-a62709bded25",
"db_language_id": "44b8ffcd-db80-4c5a-a848-1c90d4f3fa6d",
"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-30T14:15:38.512491+00:00"
},
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9c61f2a2-4952-4145-808b-e5ef7bf1a0ef",
"date_reported_by_company": "2025-11-30T14:15:38.512491+00:00",
"id2": 36,
"company_id": "83c5984e-9e25-4244-85b0-f280e10935af",
"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": "2e91085c-3c8a-41ec-9ba2-aa59be2c3693",
"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-30T14:15:38.512491+00:00"
},
"work_instruction_details_id": "789380d3-271e-42b1-87be-02178298a165",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bee0ba4f-8df4-4c33-8a92-82751f730e8c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "72a14219-f226-40b2-812e-7a4892b610bf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-30T14:15:38.512491+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": "61dec4e2-9aac-4952-8518-cf665c938f95",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-30T14:15:38.512491+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.