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": "2f011dba-5d97-40e4-8944-9f3788ec55de",
"jobs_id": "28efc8a2-a3c4-42a4-a9ed-ad91043c62dd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5418f19-8579-4a14-b75b-4454d8f9ae54",
"_parent_id": "01666fe4-a2c1-43ec-bf2a-506015c866c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d3feb1b0-3b3d-4c68-a60d-fbc07dda6c06",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7ab27d4d-7b28-4e5f-93cb-e9863551c519",
"_parent_id": "b7738c4a-d3f8-4a24-9477-63eb16f56b7b",
"root_parent_id": "818437cf-7912-4a62-8849-04548c4ef56c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0c0e1658-c0ec-46e4-8135-06233a2795c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "55391d9d-59b1-4973-ab3c-1fa901ea9429",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bfe8c946-af31-474a-ba01-946a43cdaab6",
"_parent_code": "sample string 6",
"sales_organization_id": "7d040312-fa0f-4ec0-8586-83df8519c4a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"equipment_model_id": "c9d617d4-9f44-4491-b423-04470cea473a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "89980ad4-57e5-456f-884c-72b56e18c866",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5c4fa35d-5c85-456b-98d2-426eb8afcf59",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fca0fa51-c7de-4567-ab04-5694ba8a0425",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2f42f161-765e-416c-938a-99358c21ff3e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"equipment_family_id": "9b34c949-0513-474d-a218-3d3cb755a8fd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "55391d9d-59b1-4973-ab3c-1fa901ea9429",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bfe8c946-af31-474a-ba01-946a43cdaab6",
"_parent_code": "sample string 6",
"sales_organization_id": "7d040312-fa0f-4ec0-8586-83df8519c4a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"date_in_production_since": "2026-01-05T03:16:52.540315+00:00",
"date_out_of_production_since": "2026-01-05T03:16:52.540315+00:00",
"date_end_support": "2026-01-05T03:16:52.540315+00:00",
"sales_organization_id": "89a3a131-22fa-4271-b119-5d0caae3d824",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+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-01-05T03:16:52.540315+00:00"
},
"project_status_id": "712baedd-2ff0-416a-96fa-fdc8ca49f985",
"project_status_code": "sample string 10",
"project_status": {
"id": "412cca0f-76fb-463d-b0fc-250084cdcbd9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7a37527e-62cb-47e5-9fb0-d375d0e9018b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"company_id": "658df593-b9bc-4b6e-bd3d-562fee2cdd95",
"company_code": "sample string 12",
"db_address_id": "11e07831-ba88-4431-8691-4c79431d3a7c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4e53b000-5227-45b2-9681-d4633e792226",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9cd69ef3-5b44-4512-95da-3c495c25fc99",
"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-01-05T03:16:52.540315+00:00",
"date_create": "2026-01-05T03:16:52.540315+00:00",
"date_update": "2026-01-05T03:16:52.540315+00:00",
"updated_by_user_id": "12dd0caa-6ffb-44a3-9653-57540ec1ee30",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-05T03:16:52.540315+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-01-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-05T03:16:52.540315+00:00",
"date_last_job": "2026-01-05T03:16:52.540315+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-05T03:16:52.540315+00:00",
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00",
"is_mobile_installation": true
},
"job_type_id": "a9d7e37a-22c2-4fd8-92ce-c73e237afc53",
"job_type_code": "sample string 7",
"job_type": {
"id": "9b57b757-017f-4699-b49f-40eeba2499e3",
"name": "sample string 2",
"sales_organization_id": "5cd7ceb4-832f-41fb-aabf-700134edca91",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00",
"code": "sample string 7"
},
"job_priority_id": "9c10ae7d-0fe7-40dc-855a-e6da5063fe5d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f66514d3-0739-45a3-ba43-64e07704b492",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79cf9a1e-bdf3-4fb4-90fc-74998c93ec07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"job_status_id": "3e3beee0-69a9-4337-9dc3-2b2c6fd8300e",
"job_status_code": "sample string 11",
"db_address_id": "6c048d12-8f8d-4544-b0a0-db30890ae654",
"contact_id": "211f3f5f-b3fe-4f89-9ba1-7e2b2ebd04a0",
"requested_by_company_id": "2a91efdd-3e96-4e60-a876-9769629e2564",
"requested_by_contact_id": "4278e3e8-cea9-48f5-ac38-d09ba7a20e78",
"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-01-05T03:16:52.540315+00:00",
"due_date": "2026-01-05T03:16:52.540315+00:00",
"date_create": "2026-01-05T03:16:52.540315+00:00",
"date_update": "2026-01-05T03:16:52.540315+00:00",
"date_closed": "2026-01-05T03:16:52.540315+00:00",
"suggested_user_id": "ed24e98d-5b40-4601-9f85-234b6e8296d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b8a667d5-7cc0-49dc-9b39-ea36a4578a93",
"db_language_id": "1607c8af-22ee-42e6-9e62-b68dab2f846f",
"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-01-05T03:16:52.540315+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1aa7bbf5-59f2-4603-8544-cc797d8ef582",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "39c212c7-b153-4334-b54f-2b854a1656c2",
"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": "82a39ad8-d872-4703-8eba-e24d3f45dfb0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7367a94b-ac27-4cdb-81f1-e2c0fe3427b0"
},
"suggested_date_start": "2026-01-05T03:16:52.540315+00:00",
"skill_id": "0281c2be-ada9-44be-a044-cdbbd43bc495",
"skill_code": "sample string 32",
"skill": {
"id": "5daec794-3f95-4bdd-962a-981ab4cbe9ff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6acb576d-f066-4d09-a789-faa2fe265fec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3a791298-3b81-41f4-bd69-62651b68fdd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0b7aa95d-ea11-4b83-9473-7513da8a593e",
"db_currency_id": "11055e44-413a-4294-a938-46229ddd43c2",
"db_language_id": "b331af06-bd5a-4db6-8764-b938b1c55e28",
"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-01-05T03:16:52.540315+00:00"
},
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aeec3401-34d3-48f6-92a6-f7cc0e83759f",
"date_reported_by_company": "2026-01-05T03:16:52.540315+00:00",
"id2": 36,
"company_id": "a0231c07-1eae-4a93-b0d0-f604fa5298d5",
"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": "eb806149-051e-40b9-a8f8-507ec040327b",
"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-01-05T03:16:52.540315+00:00"
},
"work_instruction_details_id": "27cdadaf-39c5-42da-b48e-a121d4e3cf2e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "61f468a0-2e5e-4ee4-aa46-fb55ae91123b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "608303fb-d037-4b69-af11-92a95532059c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-05T03:16:52.540315+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": "fa19b128-2a38-4209-b7dd-57c9a173f772",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-05T03:16:52.540315+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.