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": "431b185f-ef7c-4d6d-99bb-a3d8dd378209",
"jobs_id": "6e036fd8-00bd-48ef-b0cd-5716317a6eca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7cb9909e-8aaa-4682-ad66-1645f88e4bf4",
"_parent_id": "42fcc76e-473d-436d-939a-435ffd9b47a9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ea7c3bf8-b2fc-4ab6-bcf9-669ed6fbc374",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b722b4d0-6315-4633-9ce1-0fba6b2adebe",
"_parent_id": "41708eee-3c88-4a57-a80a-f03905536fc4",
"root_parent_id": "d7f17693-3588-4c81-8d6e-9305406a4b46",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "625f0ebe-f0db-4953-9653-b28cd049a4c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9bf80da-33f3-4699-8914-8e4576ccb65d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9687ab35-a3f7-4f69-a96d-5686c99721e3",
"_parent_code": "sample string 6",
"sales_organization_id": "8010d84d-5a43-4da2-814d-e9d88a978bbf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"equipment_model_id": "5baaf860-2ab6-4edf-b910-4e0b8330b2e9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cc82f702-391e-4210-9545-d1e4648233bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "12312427-b0f9-4e53-8884-5e0362d518b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3466663b-2b6d-4ad8-82f6-59b4385635d4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1a1801b0-32e0-4d77-9e6e-1ad8316398ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"equipment_family_id": "e2a61b38-e2fe-47ea-bdb2-ac07d257e5db",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9bf80da-33f3-4699-8914-8e4576ccb65d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9687ab35-a3f7-4f69-a96d-5686c99721e3",
"_parent_code": "sample string 6",
"sales_organization_id": "8010d84d-5a43-4da2-814d-e9d88a978bbf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"date_in_production_since": "2026-09-07T14:29:31.9491487+00:00",
"date_out_of_production_since": "2026-09-07T14:29:31.9491487+00:00",
"date_end_support": "2026-09-07T14:29:31.9491487+00:00",
"sales_organization_id": "55d0f895-bc52-42fd-adb6-21ae565b9437",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+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-09-07T14:29:31.9491487+00:00"
},
"project_status_id": "31f7c1bf-794c-46a3-86e6-fed49c36a8de",
"project_status_code": "sample string 10",
"project_status": {
"id": "a1f0f067-4c1d-411a-a8f5-a40d4e4fe960",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e1341ee3-a5ed-4fa0-9f3c-a027d6197154",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"company_id": "6ab1d97f-dfa1-47c3-8a9a-9bca55c0d94e",
"company_code": "sample string 12",
"db_address_id": "7e7f8eef-3365-4094-afa8-eecf445f2cb7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b1cfeaac-41af-4b2f-9391-39947ed96f5b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "57b14bec-97af-4b3e-9a72-e902aa6d991b",
"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-09-07T14:29:31.9491487+00:00",
"date_create": "2026-09-07T14:29:31.9491487+00:00",
"date_update": "2026-09-07T14:29:31.9491487+00:00",
"updated_by_user_id": "90374a14-a527-4649-9286-f7e12ae437c7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T14:29:31.9491487+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-09-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T14:29:31.9491487+00:00",
"date_last_job": "2026-09-07T14:29:31.9491487+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T14:29:31.9491487+00:00",
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00",
"is_mobile_installation": true
},
"job_type_id": "126395ab-cf0e-4d15-a2b2-ebe7c25427f3",
"job_type_code": "sample string 7",
"job_type": {
"id": "8faf630f-9c3a-4ec4-833b-7b69ce7e9ec9",
"name": "sample string 2",
"sales_organization_id": "7e5eee59-889b-42c5-b6cb-c9969d963e1f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00",
"code": "sample string 7"
},
"job_priority_id": "d4616893-0448-4789-81ef-14cb29459305",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d0b4d745-4cd5-46f9-81f4-988e26993fc8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d05f4cb8-6147-4362-ae2e-34c1ef3f1b61",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"job_status_id": "c2c4b65c-7e25-40f9-9ea6-bb8230b2d157",
"job_status_code": "sample string 11",
"db_address_id": "defb6ab9-751d-4e07-8ffc-7e79b053cd21",
"contact_id": "f0d7e937-3c16-4a25-ba64-9afdb05cb054",
"requested_by_company_id": "04e5281f-deae-46b0-a159-f11c9092a30e",
"requested_by_contact_id": "641880d3-6787-44d1-807a-8f817d202dee",
"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-09-07T14:29:31.9491487+00:00",
"due_date": "2026-09-07T14:29:31.9491487+00:00",
"date_create": "2026-09-07T14:29:31.9491487+00:00",
"date_update": "2026-09-07T14:29:31.9491487+00:00",
"date_closed": "2026-09-07T14:29:31.9491487+00:00",
"suggested_user_id": "8c406e12-a011-4808-b865-046a1f5f5abf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "18ee6031-b389-4ed2-a58d-84b250f16621",
"db_language_id": "01f292e7-4666-4f9d-8cd3-af9467a6f923",
"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-09-07T14:29:31.9491487+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "91d8eada-ab4b-44b6-b07a-63a6e22ba91b",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3845e9b7-c4da-406f-b383-454fac74bd35",
"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": "39be94f8-0beb-42e1-9e46-96bde1aa3eed",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fd46ab01-d4f9-4e57-b5ce-67254074c3f6"
},
"suggested_date_start": "2026-09-07T14:29:31.9491487+00:00",
"skill_id": "92907419-5d88-458f-9403-c1b703900903",
"skill_code": "sample string 32",
"skill": {
"id": "bdaf94e4-625d-4387-af11-2df47f2fab16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "420f396d-803a-46fd-82fa-e7cec53ad5a7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "62f54dee-3518-4e2a-9318-4c51e2dbe37f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c385219f-2668-4166-9fec-0a4435a617a4",
"db_currency_id": "5c3dfbb4-e2fb-43b0-9529-34b2ca040750",
"db_language_id": "8bdd40de-695e-4415-b0e4-aa751f32617a",
"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-09-07T14:29:31.9491487+00:00"
},
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6cdd85c8-2021-43ac-a74f-59564b22defc",
"date_reported_by_company": "2026-09-07T14:29:31.9491487+00:00",
"id2": 36,
"company_id": "b20c407a-223d-442f-bb1c-428bdb8fe6c1",
"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": "e260d264-d06f-4079-b2d9-383ca486aa5d",
"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-09-07T14:29:31.9491487+00:00"
},
"work_instruction_details_id": "2832a3c1-bf0f-4890-8156-083b0f792624",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "af5c7b21-4190-4387-82b4-c09137667848",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "322240e4-5da8-4c2e-b2fa-cfe8252ddce1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T14:29:31.9491487+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": "d8524130-00cb-4a9b-a221-0a659ac897bc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T14:29:31.9491487+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.