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": "7a4da019-1d78-4b29-862f-31f373043d8b",
"jobs_id": "c8bc2a36-9040-459f-bd7f-d89b6f6b7d0e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f0fdcd03-0a97-4366-b28c-b4a2d5f9b956",
"_parent_id": "5fdc64f8-c94b-4cdf-91ad-602cc58d45ae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "818f9ba6-41b1-404b-98e4-4c0ea29b0ffc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "439d21aa-7c07-4113-ac83-88d9941ac173",
"_parent_id": "70a7be82-1e5e-44af-a854-c2e555ceef90",
"root_parent_id": "9ddf91db-b83f-4e93-a5bd-e6715c4483dc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5f894778-0b39-488c-8865-3d33f17d6fc5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8489c35c-09c7-4b1a-8028-9876bdf3db67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b01c2293-e569-4315-b87a-0b6ddec66582",
"_parent_code": "sample string 6",
"sales_organization_id": "04801a4c-6122-4aae-8ead-318cb1188287",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"modified_dateutc": "2026-03-10T21:01:14.8548672+00:00"
},
"equipment_model_id": "b42fc773-e6d3-4d50-bfa2-4138c862ef79",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "abcd2e1f-01e1-405a-9994-59de87692ba6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b85b78bd-03c5-49f1-b1a2-5e8d3f5b677e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "efd4619e-f0c3-497c-8d96-75c3b83bddc2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c2580d27-f5ec-44b0-85aa-65107008ee6f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00"
},
"equipment_family_id": "6b558049-7d5d-4a4a-9ef3-9eb0303042d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8489c35c-09c7-4b1a-8028-9876bdf3db67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b01c2293-e569-4315-b87a-0b6ddec66582",
"_parent_code": "sample string 6",
"sales_organization_id": "04801a4c-6122-4aae-8ead-318cb1188287",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"modified_dateutc": "2026-03-10T21:01:14.8548672+00:00"
},
"date_in_production_since": "2026-03-10T21:01:14.8799251+00:00",
"date_out_of_production_since": "2026-03-10T21:01:14.8799251+00:00",
"date_end_support": "2026-03-10T21:01:14.8799251+00:00",
"sales_organization_id": "de89e44b-8a04-427c-9c33-3bbcb973238e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+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-03-10T21:01:14.8799251+00:00"
},
"project_status_id": "2bda64b0-fe14-4c00-8d94-8e282257d5ac",
"project_status_code": "sample string 10",
"project_status": {
"id": "7ad57298-52e3-4e12-b767-b5f2ac8f3111",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "164d2b5a-14d8-4f17-9701-743dbafb6451",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00"
},
"company_id": "1ceb0c8c-c125-4bf9-a07f-fffbc6a0c4e0",
"company_code": "sample string 12",
"db_address_id": "b0c19569-9041-4be5-a98e-7b89502287a6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "99207843-a180-4efe-b100-e42a341e2aa5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9bd5f83-2e6b-482f-8901-e64599e3c349",
"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-03-10T21:01:14.8799251+00:00",
"date_create": "2026-03-10T21:01:14.8799251+00:00",
"date_update": "2026-03-10T21:01:14.8799251+00:00",
"updated_by_user_id": "6f819d4f-de75-46ab-939a-83917b5e9d3e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-10T21:01:14.8799251+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-03-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-10T21:01:14.8799251+00:00",
"date_last_job": "2026-03-10T21:01:14.8799251+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-10T21:01:14.8799251+00:00",
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00",
"is_mobile_installation": true
},
"job_type_id": "50d74590-d2dc-4190-ace1-c3eca84556a7",
"job_type_code": "sample string 7",
"job_type": {
"id": "064f0ba6-7e60-4a95-b96e-fec137c2b4e9",
"name": "sample string 2",
"sales_organization_id": "39c5b271-3664-46c0-9df3-e20cc56a3d64",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00",
"code": "sample string 7"
},
"job_priority_id": "ac46b059-a56f-4ae5-a99d-98deded24f94",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c7a6fc79-20e0-45bd-825f-d89cfb330336",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9e3a31c0-cf99-4be0-a13f-2a041cae3a48",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00"
},
"job_status_id": "f23f8b56-808f-4132-9a1c-3e02ff1f05ca",
"job_status_code": "sample string 11",
"db_address_id": "c5eef727-a942-4329-b5ad-2a71b2175cb5",
"contact_id": "a71a81ec-fd83-4f6c-b771-fcbe12a1aea8",
"requested_by_company_id": "d3690157-432d-4113-905f-f4d0a1d99737",
"requested_by_contact_id": "1e994170-b1ee-4689-960e-17c4e1806427",
"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-03-10T21:01:14.8799251+00:00",
"due_date": "2026-03-10T21:01:14.8799251+00:00",
"date_create": "2026-03-10T21:01:14.8799251+00:00",
"date_update": "2026-03-10T21:01:14.8799251+00:00",
"date_closed": "2026-03-10T21:01:14.8799251+00:00",
"suggested_user_id": "90b5a744-73e6-46e4-8a88-5b24aac2fcfb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7c52bbe9-33c2-46d6-bf8f-f2bdc6c9dfda",
"db_language_id": "31f22dab-a421-4202-85d8-8ead0d7c6145",
"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-03-10T21:01:14.8799251+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01c98701-2d85-4a82-b5ec-dedf51f6e88e",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5555bf24-0236-48e9-9c5c-422c87f72bf1",
"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": "0ce55684-396b-4131-a431-8511743bf3f7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eeb5fc92-e06b-450e-89c0-1fd66246f0c1"
},
"suggested_date_start": "2026-03-10T21:01:14.8799251+00:00",
"skill_id": "26be9ec1-c3c2-4409-92a8-e950227397c6",
"skill_code": "sample string 32",
"skill": {
"id": "cb2e73f2-8002-44a7-8739-f5d53040afe0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f95e6b3-2a96-4c15-a558-5e2767b6784a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d034963e-30a4-4417-91c5-956d4445338b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "93242c61-06c4-4ccd-9d27-915c75eef045",
"db_currency_id": "1172ffb6-90af-4fe9-a898-d6fd81ba29fe",
"db_language_id": "94b01e2e-a595-41a4-b942-f13920d003f7",
"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-03-10T21:01:14.8548672+00:00"
},
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "512e032d-79d8-47fa-b3d7-802481ce1244",
"date_reported_by_company": "2026-03-10T21:01:14.8799251+00:00",
"id2": 36,
"company_id": "d1ccddb3-5b24-4ed9-a30e-e9ab413d9e39",
"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": "12fb8969-5cff-4dd6-b8e4-0c951b04b738",
"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-03-10T21:01:14.8799251+00:00"
},
"work_instruction_details_id": "4f81c7c9-6c60-41b4-9092-4f4e2c43b2bd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eaea3cb6-82d8-4cd1-a674-be3700292f4c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "87408548-0f5b-4fb9-a5c4-1105c1623070",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-10T21:01:14.8799251+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": "a6335422-eed8-4c35-b3df-7f4939db0149",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-10T21:01:14.8799251+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.