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": "cf5edd84-888c-4a40-ac91-7d8d4c3c2460",
"jobs_id": "740a9633-572c-40dd-8cd3-b4ad35df0841",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e273fd1f-6f2e-4345-882e-4d868ae9116d",
"_parent_id": "1887018b-cd6f-4250-ba15-bfdaf4d0f70e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4860573d-8419-4c28-a0f1-165dc7e8e1be",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d5322489-910a-4d19-8558-ec060e54b9d0",
"_parent_id": "849c963e-3846-4bde-9ccd-18bc377e205c",
"root_parent_id": "4a110308-b9ae-4823-b4bd-8ab9cbf81b92",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5c88bc92-d952-4306-bef5-9aca361a75c5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "14ed5b14-13a0-4721-a22c-37f6fce6f78b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7347cbec-c1b3-404b-8ffb-27a4af0fbad6",
"_parent_code": "sample string 6",
"sales_organization_id": "8af25c75-ce67-454b-b319-ef0d8dcac18b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"equipment_model_id": "7131e025-c243-4574-9eea-a6a8533a40c5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a716c16-6708-4bd4-9b91-45f5dec8cec5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f0057189-2588-4ae4-843f-95c5e21433a7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "33036a49-9105-4904-a854-ef42d9a490e9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b2078d6-73ff-4e4b-9915-0501cae5bde5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"equipment_family_id": "46366522-636c-459d-a436-c16de778b568",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "14ed5b14-13a0-4721-a22c-37f6fce6f78b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7347cbec-c1b3-404b-8ffb-27a4af0fbad6",
"_parent_code": "sample string 6",
"sales_organization_id": "8af25c75-ce67-454b-b319-ef0d8dcac18b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"date_in_production_since": "2026-08-29T12:20:11.6901951+00:00",
"date_out_of_production_since": "2026-08-29T12:20:11.6901951+00:00",
"date_end_support": "2026-08-29T12:20:11.6901951+00:00",
"sales_organization_id": "0aca195b-6ae3-465a-8079-a74e99861889",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+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-08-29T12:20:11.6901951+00:00"
},
"project_status_id": "98ad486d-5cb0-47df-bba0-12582857b88d",
"project_status_code": "sample string 10",
"project_status": {
"id": "10e1c135-971c-4a1f-a2fa-38f0e275f7a7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "542a7176-4ab0-4f0a-9958-5045a1ac2d88",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"company_id": "8768ff99-e149-4d71-b128-60413e8605f7",
"company_code": "sample string 12",
"db_address_id": "dc05df24-3c5f-4314-906e-c4b809db68b5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "485c84b4-ed2b-4757-8952-ecccf6b13b9a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "21a6785a-afcd-49d4-9686-361eadb7cf96",
"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-08-29T12:20:11.6901951+00:00",
"date_create": "2026-08-29T12:20:11.6901951+00:00",
"date_update": "2026-08-29T12:20:11.6901951+00:00",
"updated_by_user_id": "7f0e64ea-562d-417f-afe4-a769c8a09ced",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T12:20:11.6901951+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-08-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T12:20:11.6901951+00:00",
"date_last_job": "2026-08-29T12:20:11.6901951+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T12:20:11.6901951+00:00",
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00",
"is_mobile_installation": true
},
"job_type_id": "820d7883-4bea-488a-acf5-1a1acbbfe3e2",
"job_type_code": "sample string 7",
"job_type": {
"id": "3d755436-400a-4d81-8d04-ffe47409c88c",
"name": "sample string 2",
"sales_organization_id": "6e87220d-6aff-4408-bbdf-dc3c5d0943aa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00",
"code": "sample string 7"
},
"job_priority_id": "22e93afc-8e86-4761-8266-fb164415a6d5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5e2645cf-5eae-4b58-aa1e-dad1cadc6fde",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8a367605-2d69-4f29-967e-0dfaa8bc0290",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"job_status_id": "c9f202d7-3d29-41b3-9008-cecd1d98c3ca",
"job_status_code": "sample string 11",
"db_address_id": "90d41653-2ed0-452c-be4e-000e810da9fb",
"contact_id": "f3291d27-dc1f-4007-963f-196153c6bb93",
"requested_by_company_id": "9b0400ec-f9e7-41ed-a3da-f1808b01bcee",
"requested_by_contact_id": "5dcb03dd-af51-41d3-932a-fa5e9beb7a32",
"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-08-29T12:20:11.6901951+00:00",
"due_date": "2026-08-29T12:20:11.6901951+00:00",
"date_create": "2026-08-29T12:20:11.6901951+00:00",
"date_update": "2026-08-29T12:20:11.6901951+00:00",
"date_closed": "2026-08-29T12:20:11.6901951+00:00",
"suggested_user_id": "381da911-abcd-4ede-b485-97b008bf0d14",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "426b18a7-731f-402d-abba-2ae05e6340cf",
"db_language_id": "e4faf7c7-e3a4-43c5-b033-5a10a6c36c36",
"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-08-29T12:20:11.6901951+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e4e09280-43cd-40bc-9ec9-e62fe2de2620",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "74313ef4-c853-43a8-ba99-68cbc0b7572a",
"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": "ffcda4d8-4fc5-4dfb-b1ef-fcd3ef41699b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e19cd457-df72-40a1-985c-5fd744d5cbc2"
},
"suggested_date_start": "2026-08-29T12:20:11.6901951+00:00",
"skill_id": "cbb1e1ad-ce7f-434f-9606-9f22e9210b7d",
"skill_code": "sample string 32",
"skill": {
"id": "a1edb75b-0dcf-4f6f-b910-7732dcfd41de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cadc2a44-fb93-4565-813e-9db6c40c34b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d86d5678-2934-49d9-973f-29ae76eb2a54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5578d4b6-7b81-44ea-8865-3ca6cb1ba610",
"db_currency_id": "d500f97a-956d-4dd9-b96c-506e6836bab7",
"db_language_id": "f5e86765-a0ca-4098-b94c-849cdab750e7",
"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-08-29T12:20:11.6901951+00:00"
},
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bb8354f8-a446-4efd-8bda-6952910d00a9",
"date_reported_by_company": "2026-08-29T12:20:11.6901951+00:00",
"id2": 36,
"company_id": "4e6cb505-cf8d-4c19-95cd-e626cdeb3f05",
"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": "ffc3bd28-e423-415e-9786-fec8addeb614",
"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-08-29T12:20:11.6901951+00:00"
},
"work_instruction_details_id": "e559f772-dec3-441f-8de8-2a59fb5fc2d1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "294f1c3c-bb16-468a-8260-5b488a0583cc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d5bc9e6a-9e1c-4b65-9e32-3c58cfe36e5c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T12:20:11.6901951+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": "c1f1e33c-1689-461c-8269-f76172ab7b15",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T12:20:11.6901951+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.