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": "564c8e2e-933b-48d7-886b-3f9aea98d6bf",
"jobs_id": "e48b0679-fe06-462b-889c-c38e65772330",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b0ce1fd0-570c-4417-a869-ec06df24c9d6",
"_parent_id": "b69159c8-3210-4b71-a50b-5e0053c7c84c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eb5557a9-6b33-4cb0-8c45-0e8d31f1a2a5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e7808bf4-46a0-407a-a0ed-07ae8e9c6c0b",
"_parent_id": "2b82b6ea-2b83-494f-b215-4620ca30308f",
"root_parent_id": "b339d9ca-c04a-4ae3-adaf-2033654259e2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9f464ef3-9c89-4b5f-9147-2f38c9337036",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "be3b68c8-86d6-400d-91b2-25af2ca80e7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64e8986f-1636-4566-9550-b2246bfca5af",
"_parent_code": "sample string 6",
"sales_organization_id": "04002d7e-eb85-4999-9515-333ef03eb4cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"equipment_model_id": "f00c052e-9246-4bee-a7d6-751accec456b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b06e5f2c-f67e-4cf8-bf5c-c5073e9d99db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a23cbacd-7030-48db-9f5b-dc8799fb7c4e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d935fe99-0d82-4dfa-b593-9ab961c8b66b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8e8bdd5e-5c42-495c-86bd-f631e5b6c543",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"equipment_family_id": "2933cffe-3dac-4d4c-abc5-17b2a395810a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "be3b68c8-86d6-400d-91b2-25af2ca80e7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "64e8986f-1636-4566-9550-b2246bfca5af",
"_parent_code": "sample string 6",
"sales_organization_id": "04002d7e-eb85-4999-9515-333ef03eb4cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"date_in_production_since": "2025-12-15T18:58:10.0543553+00:00",
"date_out_of_production_since": "2025-12-15T18:58:10.0543553+00:00",
"date_end_support": "2025-12-15T18:58:10.0543553+00:00",
"sales_organization_id": "0b933891-afdf-4ab5-b03b-3aba756ff0c0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+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": "2025-12-15T18:58:10.0543553+00:00"
},
"project_status_id": "278e3125-d638-4ff3-a2bc-0ce05197ae66",
"project_status_code": "sample string 10",
"project_status": {
"id": "1b4191bc-9466-4cfb-b1f0-09a0b938d1a2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5bd363db-9106-418a-a2dd-f0a797af6962",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"company_id": "51002f1f-3d7b-4372-ae10-736fd83990cd",
"company_code": "sample string 12",
"db_address_id": "1550c097-067b-4f42-abaa-4abc5c5b5f54",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41e1b876-89f9-430a-b939-3e561922e0e5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7b5944b7-ce5a-4d13-a59b-0286f07db4fc",
"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": "2025-12-15T18:58:10.0543553+00:00",
"date_create": "2025-12-15T18:58:10.0543553+00:00",
"date_update": "2025-12-15T18:58:10.0543553+00:00",
"updated_by_user_id": "a0dd1547-d4ef-4593-a5a6-e6bbc6878a3e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-15T18:58:10.0543553+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": "2025-12-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-15T18:58:10.0543553+00:00",
"date_last_job": "2025-12-15T18:58:10.0543553+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-15T18:58:10.0543553+00:00",
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00",
"is_mobile_installation": true
},
"job_type_id": "688a7b03-3dba-4113-b4be-b94e0cdfc52b",
"job_type_code": "sample string 7",
"job_type": {
"id": "34b661d5-a222-4231-b7c0-c79a69ce0305",
"name": "sample string 2",
"sales_organization_id": "b9f3222c-3020-4784-bfed-9ddc4fc416b0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00",
"code": "sample string 7"
},
"job_priority_id": "11a6d7fa-6fb2-4d38-8f4b-17a9f36b1ac8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "159206bd-fac4-4ac8-905f-9dc46cbebddc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1cddca00-4958-46b9-bbc5-a17d78a652c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"job_status_id": "d43ca6fd-1b9d-440d-8fca-4f8abd3b8584",
"job_status_code": "sample string 11",
"db_address_id": "c3887a2f-0205-464a-8423-3c07da9e0472",
"contact_id": "3e6e149f-55f0-4223-9891-3d63b303ed76",
"requested_by_company_id": "cf46ede2-a372-45d3-bed9-51670b7a78a2",
"requested_by_contact_id": "39a780f1-4677-49f2-89f9-650d8d6cb967",
"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": "2025-12-15T18:58:10.0543553+00:00",
"due_date": "2025-12-15T18:58:10.0543553+00:00",
"date_create": "2025-12-15T18:58:10.0543553+00:00",
"date_update": "2025-12-15T18:58:10.0543553+00:00",
"date_closed": "2025-12-15T18:58:10.0543553+00:00",
"suggested_user_id": "2282cdc9-5626-416b-a73c-550eff067811",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0e51d19e-9288-40c2-a956-c72b76ee99c3",
"db_language_id": "65531c05-3fcc-4fb9-b169-aa4beedb6622",
"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": "2025-12-15T18:58:10.0543553+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc4515c3-ea0a-4bac-a40d-3f4500e736a7",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0a6bcd4d-9473-46c4-a001-dbf8ae6e88c8",
"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": "676299d3-6c56-4b4e-b6cf-db4fcbf85e4c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d84fc2a3-bd55-496e-8550-3b64ace09357"
},
"suggested_date_start": "2025-12-15T18:58:10.0543553+00:00",
"skill_id": "e59f38a3-772e-4954-a4ea-0a0669c98235",
"skill_code": "sample string 32",
"skill": {
"id": "8064b7de-8136-420a-9f4b-b7f94014cb4f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c67737b5-9b0b-4801-9252-eb99827e9412",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1f2d464c-4cb8-4cad-8405-0333cd266ce3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d47f8524-c5b2-4f31-be13-eb628ded0f98",
"db_currency_id": "99d4078e-662e-4ffe-9a5a-3c1e031a0302",
"db_language_id": "d88bf807-334c-4d1b-a933-a02d64232efe",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b7f38af2-f546-4b4d-abe0-bd2caed37eda",
"date_reported_by_company": "2025-12-15T18:58:10.0543553+00:00",
"id2": 36,
"company_id": "5a0f6b43-87be-4768-ab6d-ec5edd4f127b",
"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": "2ff36691-ccf6-455c-a7ab-8d92625f52bb",
"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": "2025-12-15T18:58:10.0543553+00:00"
},
"work_instruction_details_id": "4424c47b-f36a-4282-8298-992a68d9bb53",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "94954544-e7a6-4b01-86a7-44f682dc3f96",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c9a98e64-8d3c-46d6-b841-0157cb006c34",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-15T18:58:10.0543553+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": "8ff3cd44-ca5a-4267-a821-79686ca7d550",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-15T18:58:10.0543553+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.