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": "64831ab1-270e-46a3-a42b-c2df25fbd461",
"jobs_id": "d6a0143d-161c-474e-8d68-d88ca25589b6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "00f9fae1-4a34-4592-a537-dc7cfd1e2f42",
"_parent_id": "c7d2ba30-4f1d-4452-9d37-3f806e6a1a4a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bc9ea510-84f4-4ff6-901a-ab2aa1e8cd2d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5c5394a3-6ec2-4ee5-9f13-26f097bdb932",
"_parent_id": "0b73abb7-c775-4f96-9cae-e0eba29f0eda",
"root_parent_id": "02085c6e-0eb3-4009-b19c-699604bade5c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "951614d9-bf34-436f-994b-12716904db01",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1f88f892-d212-423e-b298-372a6ad0cb3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc08daf9-58d5-4015-bbe2-58089272e859",
"_parent_code": "sample string 6",
"sales_organization_id": "881904e1-2534-4405-ba6a-a3539de672a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"equipment_model_id": "76699c65-6c99-4f6d-9d0e-20789ed8744d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0e28d0b5-b68e-41f2-9be3-4f998090359d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c7db1977-3566-45a6-9996-d9950fc8eb85",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3943036f-15f5-4d4a-b5db-1c7cb27aaeba",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3f65d3d6-8945-446a-91ec-b7724f502763",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"equipment_family_id": "37b47ca4-2a79-40fb-ae31-16e17f0fa82b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1f88f892-d212-423e-b298-372a6ad0cb3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cc08daf9-58d5-4015-bbe2-58089272e859",
"_parent_code": "sample string 6",
"sales_organization_id": "881904e1-2534-4405-ba6a-a3539de672a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"date_in_production_since": "2026-02-04T09:45:52.8659723+00:00",
"date_out_of_production_since": "2026-02-04T09:45:52.8659723+00:00",
"date_end_support": "2026-02-04T09:45:52.8659723+00:00",
"sales_organization_id": "f4516d9f-0f71-461e-a17c-afeca885fe11",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+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-02-04T09:45:52.8659723+00:00"
},
"project_status_id": "9350c7ce-9d67-4706-895e-f8ac0bef7b73",
"project_status_code": "sample string 10",
"project_status": {
"id": "f2cd7aa3-3410-406a-b8b3-432f9dfec074",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bba1d9bd-050d-4d40-b6f5-cc478541c5c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"company_id": "be97ee90-446e-4e23-8e31-973dc64c7ce6",
"company_code": "sample string 12",
"db_address_id": "2f9c8421-6a02-4cb7-8bd8-bd23ca6660ed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1feb9663-4a30-4cfb-a91e-12029096a9c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d2041173-c1c3-4bd8-9d46-cfcb31f49f9e",
"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-02-04T09:45:52.8659723+00:00",
"date_create": "2026-02-04T09:45:52.8659723+00:00",
"date_update": "2026-02-04T09:45:52.8659723+00:00",
"updated_by_user_id": "e474b441-2f9d-4783-88f7-9a7d7e07f320",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-04T09:45:52.8659723+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-02-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-04T09:45:52.8659723+00:00",
"date_last_job": "2026-02-04T09:45:52.8659723+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-04T09:45:52.8659723+00:00",
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00",
"is_mobile_installation": true
},
"job_type_id": "d015d564-0463-40f5-918b-73c5da86da2a",
"job_type_code": "sample string 7",
"job_type": {
"id": "ff55afc1-156f-45a1-9e2d-38a1d959671f",
"name": "sample string 2",
"sales_organization_id": "09f730c1-0c58-476e-9085-304998239096",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00",
"code": "sample string 7"
},
"job_priority_id": "884f9e1f-7f5a-48e3-9838-7583daef2880",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4e36b31b-f94b-4de2-8de0-d739cab8e2bf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "07a23da9-ea17-4831-a3ed-115f8266b3ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"job_status_id": "e004d5ec-d616-49da-b46e-45567d80f598",
"job_status_code": "sample string 11",
"db_address_id": "335519c1-87e9-4d6d-a0e8-dc06a58fa876",
"contact_id": "4299df31-4822-44b7-80dc-fbde807131ae",
"requested_by_company_id": "ea4684b1-8827-4cdf-8e56-c21c5f17cfc2",
"requested_by_contact_id": "642d6128-7a5b-49ce-a256-d7344093a679",
"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-02-04T09:45:52.8659723+00:00",
"due_date": "2026-02-04T09:45:52.8659723+00:00",
"date_create": "2026-02-04T09:45:52.8659723+00:00",
"date_update": "2026-02-04T09:45:52.8659723+00:00",
"date_closed": "2026-02-04T09:45:52.8659723+00:00",
"suggested_user_id": "a09078a0-4c41-44fb-ad2c-410dc0619209",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e9a1cc3c-f2a5-42e3-ab21-82564c3df507",
"db_language_id": "9eb58d6c-e3a6-42ed-bb49-04b3b6910fba",
"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-02-04T09:45:52.8659723+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8d2b55a4-8e79-4a2e-a6cc-331667604b04",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "574d1250-6ceb-4b35-a33c-dcf6466d9b5b",
"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": "6c3f79b1-4ca5-4a84-8c48-6f4f4f6bd95d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b78540d3-cae9-4998-b08a-3f8317825f28"
},
"suggested_date_start": "2026-02-04T09:45:52.8659723+00:00",
"skill_id": "6c678885-9dab-4a24-8ab2-b993387eb1f5",
"skill_code": "sample string 32",
"skill": {
"id": "be7c6746-0295-46f6-b03a-8d055c06d8a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "54665c12-fd4c-433e-b339-1688b289f52e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d66b1927-b7b8-4da8-b942-77bae5aa7fc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8396a4c1-8ca0-42f6-8476-26bb17ed9441",
"db_currency_id": "db0631f8-53cb-415d-bdfd-720a5ec5b3ea",
"db_language_id": "72f8f46f-2a2f-4591-807c-31d851c7b0ad",
"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-02-04T09:45:52.8659723+00:00"
},
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b3ed8d9d-0996-4200-8726-6683ae7b5bf5",
"date_reported_by_company": "2026-02-04T09:45:52.8659723+00:00",
"id2": 36,
"company_id": "a489db1a-d61a-4cca-9e2b-4c11b54e373b",
"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": "cbf2020b-cd39-4cd4-9f8a-e08e9bbaf81a",
"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-02-04T09:45:52.8659723+00:00"
},
"work_instruction_details_id": "82c5ff4c-c8a1-46e5-921d-4cfd602b6593",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e6b08e61-c2c1-43ba-8e28-5de4eced02a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dccee265-3fa2-4c4d-af35-f709b67fedb5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-04T09:45:52.8659723+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": "29f3578c-4335-4857-815a-832f4af3cbca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-04T09:45:52.8659723+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.