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": "a64e8b15-653d-4702-a2b2-30b1f1884d64",
"jobs_id": "cddd19c6-0b96-43de-b6dd-af31239e1b0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c5953462-88e6-4857-bddb-f69f6a42207c",
"_parent_id": "df31f3b1-6d1a-489c-9816-d2331419964e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caffefd6-1d27-4849-8a92-9f61c544744f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d02fe9c9-1929-482c-93c6-ec85ee6157d2",
"_parent_id": "88d3ca9b-c3d8-494d-9a58-1578adc722e0",
"root_parent_id": "ddc591f7-c45b-42b3-a3b1-33db3fc65ffa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6eea2e01-1fff-41b8-90b2-069596cd8dd8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5812881f-5abc-4e54-84fb-ebcd095e2775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2d79cf2-df70-406b-9d8e-944f72608287",
"_parent_code": "sample string 6",
"sales_organization_id": "32d0a815-7984-4807-b810-b4f10c9480c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"modified_dateutc": "2026-10-01T09:29:49.0688684+00:00"
},
"equipment_model_id": "d7d3e0d7-61b6-4222-88cc-1e42617a684c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aa0119dd-471f-411c-8ae5-303e87b28ccc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2d4cfb98-df0a-43ef-88a1-5a3adf08d586",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5093f54f-d0ab-49d9-aea6-e732e4dacd38",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "edb7407d-1370-42d6-a76c-206b6f306fbf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00"
},
"equipment_family_id": "58468547-9f78-497e-ab28-1e8ddb01f885",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5812881f-5abc-4e54-84fb-ebcd095e2775",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2d79cf2-df70-406b-9d8e-944f72608287",
"_parent_code": "sample string 6",
"sales_organization_id": "32d0a815-7984-4807-b810-b4f10c9480c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"modified_dateutc": "2026-10-01T09:29:49.0688684+00:00"
},
"date_in_production_since": "2026-10-01T09:29:49.078866+00:00",
"date_out_of_production_since": "2026-10-01T09:29:49.078866+00:00",
"date_end_support": "2026-10-01T09:29:49.078866+00:00",
"sales_organization_id": "ba2aec33-6be4-4720-a944-c08103b92762",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+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-10-01T09:29:49.078866+00:00"
},
"project_status_id": "c663b4fe-aa7d-4531-98cb-85640faee0bf",
"project_status_code": "sample string 10",
"project_status": {
"id": "5e8af51d-df2a-4716-8c09-b23d0a6da3f3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6045f3e1-21a3-41f9-90eb-63a15bd9a883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00"
},
"company_id": "04d373d6-0e37-4925-9cbb-941c6c265343",
"company_code": "sample string 12",
"db_address_id": "15f0ebc0-40b1-48a6-a6f7-4515128f1f80",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "97fedb08-325a-4021-98d3-824f2196ae55",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5a37ef19-544e-43eb-b1ff-5beadf1abc14",
"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-10-01T09:29:49.078866+00:00",
"date_create": "2026-10-01T09:29:49.078866+00:00",
"date_update": "2026-10-01T09:29:49.078866+00:00",
"updated_by_user_id": "a117892d-5f30-4dd1-90e1-cd1d699d4d19",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-01T09:29:49.078866+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-10-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-01T09:29:49.078866+00:00",
"date_last_job": "2026-10-01T09:29:49.078866+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-01T09:29:49.078866+00:00",
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00",
"is_mobile_installation": true
},
"job_type_id": "aa82c108-5674-422a-8318-1b2747555ed7",
"job_type_code": "sample string 7",
"job_type": {
"id": "c1da81c7-cbfe-42d4-bbd4-f60983748839",
"name": "sample string 2",
"sales_organization_id": "4e0d5bbf-f18f-4089-8c3d-729fcb607285",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00",
"code": "sample string 7"
},
"job_priority_id": "76932065-fa67-4f9a-933e-ede6f051f21d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b1b91077-8caa-4f3a-a3f7-74a06a831096",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "370d612f-57c2-47bd-bdd3-7290803dfd5c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00"
},
"job_status_id": "d270057b-c4c0-46f2-8574-ec0e412de401",
"job_status_code": "sample string 11",
"db_address_id": "d7c29d6d-2ee2-46ad-b855-c2618e7797f7",
"contact_id": "b9cadac5-5899-41d2-8943-ae8d09036b3f",
"requested_by_company_id": "a62b947c-9b51-4cdf-abef-290c0451d25d",
"requested_by_contact_id": "c4a244fb-5f35-41db-a041-0c7f550e364e",
"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-10-01T09:29:49.078866+00:00",
"due_date": "2026-10-01T09:29:49.078866+00:00",
"date_create": "2026-10-01T09:29:49.078866+00:00",
"date_update": "2026-10-01T09:29:49.078866+00:00",
"date_closed": "2026-10-01T09:29:49.078866+00:00",
"suggested_user_id": "a5a9b979-1642-43b3-a941-638b71d90b3c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "738febc5-f390-406e-bbde-11f5f6b76b25",
"db_language_id": "bef761eb-8da4-4b76-abec-78e64325d77d",
"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-10-01T09:29:49.078866+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7d98a38d-5aa3-4dbf-8138-b8a83c6a4176",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "44707c20-47fc-475a-8f6e-85c97421cd2c",
"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": "6450e1aa-ce87-43b2-b862-1144e87037e4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dc4f707b-ae21-4fba-be0c-89c52cccd269"
},
"suggested_date_start": "2026-10-01T09:29:49.078866+00:00",
"skill_id": "6ad541ae-c662-4863-8288-ad44443b8b68",
"skill_code": "sample string 32",
"skill": {
"id": "50817fce-a5f7-4b15-9349-97e95b666f25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f0fef52e-184d-45b2-80b5-cff578443866",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f47aacf1-40dd-4df6-8abd-3f3be98e36c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eb0d95b-8e95-40fa-979e-bb8b97a2498c",
"db_currency_id": "ce3951bb-e8be-4b51-85c2-570ff2c9ee49",
"db_language_id": "60c09358-42bc-4d98-a35d-63b473357ffb",
"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-10-01T09:29:49.0688684+00:00"
},
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "86be7937-7d8e-4382-a95e-ca33f2e53e25",
"date_reported_by_company": "2026-10-01T09:29:49.078866+00:00",
"id2": 36,
"company_id": "e300a035-7f59-4ddb-8296-86870692e894",
"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": "8b8ea4f2-d70a-43f5-bc6d-6d01d9f3afeb",
"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-10-01T09:29:49.078866+00:00"
},
"work_instruction_details_id": "05a7599d-0eeb-4768-94b6-0ca5fc9ba8a2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f9f7891-cd2e-4288-b676-d1640f763016",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9c134413-d897-414b-8022-c8a89e5647fe",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-01T09:29:49.078866+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": "25bba170-e7c7-4d27-b82c-59612224a597",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-01T09:29:49.078866+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.