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": "b9888064-5d10-4bc7-9931-accfb8e060c5",
"jobs_id": "53e95451-7035-4df3-9629-58be1923c8b7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "edf76fa7-6524-4353-88d9-361e53e6428f",
"_parent_id": "b83739c1-0969-4106-8e74-b7cf770e1ac6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "51568ef6-d64c-4d63-abde-a9c4def83f31",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8854c390-5d2f-4432-bf50-63f9012005d2",
"_parent_id": "dd8e8c55-03ea-423f-9c19-855135d94c8a",
"root_parent_id": "732e30cf-cce5-4b5a-99c9-ac148531e46e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3a5d4a22-c36e-4e6e-a3a4-e7358c92b62e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18ffc47a-5442-4bdb-a4ff-7880522b35e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fae28af5-b17f-4413-a3f9-b595c1e0783e",
"_parent_code": "sample string 6",
"sales_organization_id": "f5cda296-18fb-4c90-a8f1-0a2af6c0b3ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"modified_dateutc": "2026-01-26T05:39:16.0069523+00:00"
},
"equipment_model_id": "7a67a15d-5e1c-45d1-9b4d-7414ff9658c8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "735595b7-d2fc-452b-b69e-9c357da220b7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cc20e6bc-095d-4b80-a1a9-a2ae13085797",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ab1b9fc9-84fe-43ca-9d93-6e133027e8bf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0f9d4366-aefb-44c6-83f1-5e47094d4eed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"modified_dateutc": "2026-01-26T05:39:16.0069523+00:00"
},
"equipment_family_id": "3c52a2bb-38af-403b-894c-838937cc43b0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18ffc47a-5442-4bdb-a4ff-7880522b35e9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fae28af5-b17f-4413-a3f9-b595c1e0783e",
"_parent_code": "sample string 6",
"sales_organization_id": "f5cda296-18fb-4c90-a8f1-0a2af6c0b3ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"modified_dateutc": "2026-01-26T05:39:16.0069523+00:00"
},
"date_in_production_since": "2026-01-26T05:39:16.0069523+00:00",
"date_out_of_production_since": "2026-01-26T05:39:16.0069523+00:00",
"date_end_support": "2026-01-26T05:39:16.0069523+00:00",
"sales_organization_id": "4690e23d-6c26-4bf8-8ac4-915c3a1f8323",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+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-01-26T05:39:16.0225649+00:00"
},
"project_status_id": "991b6da0-212f-4d2d-ba65-49aedcb46306",
"project_status_code": "sample string 10",
"project_status": {
"id": "b0545550-7e0b-4258-a500-6d9bbaf39c05",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cd39f5f1-ec60-47d0-b326-1c1816198e35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00"
},
"company_id": "011fa8fe-afe5-4e8d-8ea9-bfdba5cd9a9f",
"company_code": "sample string 12",
"db_address_id": "c78f8c2d-9af4-427d-8568-58c7fb74fc88",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ca4d9ed5-9326-4a8d-adf6-f7b632e4dd22",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9487d907-79fb-4ce4-ace6-17fd4a783edf",
"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-01-26T05:39:16.0225649+00:00",
"date_create": "2026-01-26T05:39:16.0225649+00:00",
"date_update": "2026-01-26T05:39:16.0225649+00:00",
"updated_by_user_id": "4518a32b-e263-4032-b27b-91f4942fa7cb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-26T05:39:16.0225649+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-01-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-26T05:39:16.0225649+00:00",
"date_last_job": "2026-01-26T05:39:16.0225649+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-26T05:39:16.0225649+00:00",
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00",
"is_mobile_installation": true
},
"job_type_id": "267306fb-97d5-4296-956c-09333bc698f5",
"job_type_code": "sample string 7",
"job_type": {
"id": "695cc2ef-9ddc-4961-b6d7-dedf26ab6d43",
"name": "sample string 2",
"sales_organization_id": "796816e1-69e7-414b-a229-99730b9f8091",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc5ae5f2-4a2a-4ec2-b152-7b7f7efe5a67",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b8c985db-cd7d-433d-8c1a-57dd3857b230",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d4509e15-51f3-4b24-91b4-5cebfcb35c86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00"
},
"job_status_id": "eb100fb8-5f9b-443b-9259-b6d1ec368209",
"job_status_code": "sample string 11",
"db_address_id": "afa18631-2f90-4e96-aeda-60e4883d6856",
"contact_id": "a5393ecb-ff5a-45ad-962d-b16676e82655",
"requested_by_company_id": "2726cc9a-5bcf-43b2-b77e-0daa2cdc9241",
"requested_by_contact_id": "2e330974-4aa8-495f-874a-75ed5bb53f87",
"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-01-26T05:39:16.0225649+00:00",
"due_date": "2026-01-26T05:39:16.0225649+00:00",
"date_create": "2026-01-26T05:39:16.0225649+00:00",
"date_update": "2026-01-26T05:39:16.0225649+00:00",
"date_closed": "2026-01-26T05:39:16.0225649+00:00",
"suggested_user_id": "9f3c9242-3479-4077-bc5b-1671e4fc1b59",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "96576142-f905-44f9-b5ba-dc6b9c81defb",
"db_language_id": "56f652d9-1c46-4123-bd53-1afe884fd629",
"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-01-26T05:39:16.0225649+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e1580865-9dff-4b9a-ae96-3c4e673f3878",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "109ef39a-f399-4518-a1a3-c80564c78ef7",
"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": "b4af8f8b-0cdf-49d4-aca0-4c3d92f69b87",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "df7e3794-a303-4f89-ab1f-e44014efc356"
},
"suggested_date_start": "2026-01-26T05:39:16.0225649+00:00",
"skill_id": "21163b6c-f1b7-4987-b565-3d98dda4e5ed",
"skill_code": "sample string 32",
"skill": {
"id": "4ab8b3fc-8c01-4066-83d0-3ca51f859258",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "04421812-ba8f-4274-9729-854dbd781028",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6d12e7bf-6556-44bd-af12-36cbbe3b0210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "506d02fa-3971-40cb-99b9-9ca151535307",
"db_currency_id": "a9280167-3f6c-4512-8e86-1ebf610e89fd",
"db_language_id": "e2e67d37-da63-4774-aafb-abec895c93ba",
"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-01-26T05:39:16.0069523+00:00"
},
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fddd6487-8b34-491a-abf2-7b8fb7424064",
"date_reported_by_company": "2026-01-26T05:39:16.0225649+00:00",
"id2": 36,
"company_id": "a81f13f7-3fb5-4005-8c21-fd90d138b963",
"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": "a0f9c7e5-c59b-4b52-980f-0b7e37cc2194",
"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-01-26T05:39:16.0225649+00:00"
},
"work_instruction_details_id": "daff4df7-80c6-4d63-9e50-a44150ee1ca3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6e8237d1-2c08-4789-8b23-b9c306f4ae11",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d41f6593-b410-448e-91e2-25eab979871b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-26T05:39:16.0225649+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": "d43fbbd6-0ab0-4096-8530-78aaf1876b7a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-26T05:39:16.0225649+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.