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": "6d55b130-5fc9-47a2-a195-129f487a6be5",
"jobs_id": "c74cd7c3-292b-45aa-ab6f-ff7a4efe7927",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9c35b1d5-610d-49f1-9057-edfd3c294c38",
"_parent_id": "bb225441-5ade-443c-8795-8041f9d4fe8f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac6fc188-b274-45ce-9f07-4ed61ca51d7d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bba7aa15-5cbc-47a5-946b-74931d8efd4f",
"_parent_id": "6c404782-55a0-4f41-a5b3-d51c13342266",
"root_parent_id": "854d752e-a603-4ddd-8729-9157482c467b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9b3df227-a2d5-4d7b-8a6b-581a6222dde9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b69b0d7b-7fc6-4db1-a037-0873820fecab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1c52a67-1e13-4edd-832c-c8c2fe97bff9",
"_parent_code": "sample string 6",
"sales_organization_id": "ec06a48b-9fdd-48f2-94a3-e23588fda024",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"equipment_model_id": "f691027f-f6dc-44bd-a25f-ce4abcc0d1d9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "258b24a9-b316-49d7-abc8-bfe9a7b52c5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "92e2fef3-6aa2-442d-bc6d-a97a072a928f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "977461bc-0e85-4156-b813-b8d8f3dae3e1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3941b3c4-7253-4f97-8e9d-d5ad56f665ff",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"equipment_family_id": "94b4866f-ef1d-4f95-b75c-edaf0d882bb3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b69b0d7b-7fc6-4db1-a037-0873820fecab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e1c52a67-1e13-4edd-832c-c8c2fe97bff9",
"_parent_code": "sample string 6",
"sales_organization_id": "ec06a48b-9fdd-48f2-94a3-e23588fda024",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"date_in_production_since": "2026-03-12T22:02:00.3417031+00:00",
"date_out_of_production_since": "2026-03-12T22:02:00.3417031+00:00",
"date_end_support": "2026-03-12T22:02:00.3417031+00:00",
"sales_organization_id": "2204e8c3-c882-46c3-9ac4-95e438a3a76a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+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-03-12T22:02:00.3417031+00:00"
},
"project_status_id": "da04d282-7295-4d65-85b8-675d75ec20c6",
"project_status_code": "sample string 10",
"project_status": {
"id": "0f6ed7e8-9869-4ec0-8d48-1155d5845fcf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4de93c9a-4ac6-48f3-bc26-8d5feb05d009",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"company_id": "4eeec6c9-8c0e-4e7e-84ed-526cee3148ad",
"company_code": "sample string 12",
"db_address_id": "3b68451c-c915-4c40-89a0-68a31295051a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7f658800-78d9-4995-9a3a-a8bf3139f4ee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "86a88429-2dcd-4836-aad7-0119e3d89ba3",
"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-03-12T22:02:00.3417031+00:00",
"date_create": "2026-03-12T22:02:00.3417031+00:00",
"date_update": "2026-03-12T22:02:00.3417031+00:00",
"updated_by_user_id": "f08cf646-5675-4307-8660-11dc3a1943ba",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T22:02:00.3417031+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T22:02:00.3417031+00:00",
"date_last_job": "2026-03-12T22:02:00.3417031+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T22:02:00.3417031+00:00",
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00",
"is_mobile_installation": true
},
"job_type_id": "9cc01c17-626b-454b-a18f-a6ebb4e9d573",
"job_type_code": "sample string 7",
"job_type": {
"id": "f23ae108-faf5-4f38-bb1d-9e5718cf659a",
"name": "sample string 2",
"sales_organization_id": "7a9bd2dd-dc0e-46fa-b0e5-45a39d2f5e66",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00",
"code": "sample string 7"
},
"job_priority_id": "f8462ff4-1489-4862-820f-fe2858ba3137",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a14ff96d-4e88-42ac-bfa7-11535a242366",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "30bdbc8a-d75e-4822-bb47-ce5b79853e3d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"job_status_id": "4d342b9b-8d3a-46bb-9357-ef0a646199cb",
"job_status_code": "sample string 11",
"db_address_id": "a430445c-88d9-4362-89c1-16d307a05463",
"contact_id": "aff7541e-2d10-4614-a7bc-43232ca81481",
"requested_by_company_id": "15a659b5-8bd8-4b3c-9926-bd7517f73168",
"requested_by_contact_id": "4481d028-7c7c-47b9-ad07-8e995b80cc4c",
"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-03-12T22:02:00.3417031+00:00",
"due_date": "2026-03-12T22:02:00.3417031+00:00",
"date_create": "2026-03-12T22:02:00.3417031+00:00",
"date_update": "2026-03-12T22:02:00.3417031+00:00",
"date_closed": "2026-03-12T22:02:00.3417031+00:00",
"suggested_user_id": "2d224fee-e7e2-48ed-b16c-811b9a71b47d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "505182df-e791-4ea2-80ee-e8fb0dffc888",
"db_language_id": "835f8611-f8d8-4bef-a7d6-c83abaf51b83",
"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-03-12T22:02:00.3417031+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e24cb121-f0e3-40b9-aab6-66416133eac2",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "744da27d-cb4e-40fa-a68d-16f416a01fda",
"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": "fcda5b42-f336-41bd-a26b-b56e0ab78ef8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c3480341-a4eb-4694-9f6d-96370df383ee"
},
"suggested_date_start": "2026-03-12T22:02:00.3417031+00:00",
"skill_id": "14d59b09-efa7-4459-9a4a-9b25f58e6b5c",
"skill_code": "sample string 32",
"skill": {
"id": "e9eff41d-3b73-4050-86c0-61a9d083e1ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5767a94d-9ff5-4143-8c00-b568cb1ef5cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "66acea94-e439-4feb-9058-666c68293a3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee46477-9926-4ca0-af7a-060f5d225fa6",
"db_currency_id": "19a57ab8-5213-4454-a7dc-efc64806c6c3",
"db_language_id": "63b096a4-3a4f-4ade-bc30-1bcad1362b2b",
"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-03-12T22:02:00.3417031+00:00"
},
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "df29da9d-6724-4b7b-8c4d-e64d9db8550a",
"date_reported_by_company": "2026-03-12T22:02:00.3417031+00:00",
"id2": 36,
"company_id": "60237dd9-5683-40f9-97c1-4edadec3d554",
"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": "b92bb6aa-a35e-482b-84f9-8f97e40e857e",
"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-03-12T22:02:00.3417031+00:00"
},
"work_instruction_details_id": "fa4e7bce-2e7f-4814-9819-fbfbb3942652",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7ad12612-f2fa-4a1f-bbde-08394087b869",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5d25d8c9-6b50-4728-b000-8a032f03fa38",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T22:02:00.3417031+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": "7b588cc0-9d22-4408-b16c-ba62572e0669",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T22:02:00.3417031+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.