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": "6306e7ae-ff56-439b-a268-951d6d02ae27",
"jobs_id": "227adbbc-b72f-49d4-bbee-71188a229973",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8ca0b5b1-ea75-43f0-a3f2-3d30d739cbbb",
"_parent_id": "a002e2c1-877d-4994-8cdd-23ea7778cb9d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "db63a320-9d1c-4ccd-856d-0e992d129f14",
"project_reference_back_office": "sample string 5",
"project": {
"id": "baeaa0e9-26a6-4412-9509-c59a8057fa9c",
"_parent_id": "4826b866-ab1c-4264-9596-5eb399dc596a",
"root_parent_id": "f44e9291-be97-43de-926f-7a2ecb9c45d0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d08ef7fe-7250-453d-b2aa-60f7d08f80d9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3eedc09d-fbe9-47e0-9699-e1b3f0a79089",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8ee5534-a2a9-4775-8e2c-a202af53fd1d",
"_parent_code": "sample string 6",
"sales_organization_id": "da4cf627-6d7e-4d41-8d25-6f954c230d04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"equipment_model_id": "48686fa3-0488-470e-b4e6-ea84146159f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c7ba2cf8-2a3f-4e5e-9819-bfe903d2cf5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "57d3d4ff-ddd1-4b83-9c9c-5fa889ec8cca",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ca60ac00-253b-407f-bf15-73fa6702a56d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "62dfd2ac-ee13-41d7-ba63-b4eb486429fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"equipment_family_id": "204a0436-34e8-40a4-b2fa-e562ea483244",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3eedc09d-fbe9-47e0-9699-e1b3f0a79089",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8ee5534-a2a9-4775-8e2c-a202af53fd1d",
"_parent_code": "sample string 6",
"sales_organization_id": "da4cf627-6d7e-4d41-8d25-6f954c230d04",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"date_in_production_since": "2026-06-05T10:39:15.6570117+00:00",
"date_out_of_production_since": "2026-06-05T10:39:15.6570117+00:00",
"date_end_support": "2026-06-05T10:39:15.6570117+00:00",
"sales_organization_id": "7617e05e-05ca-4cb8-8834-018752e3f392",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+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-06-05T10:39:15.6570117+00:00"
},
"project_status_id": "18ef5a55-ecd2-41cf-9715-c2f512359e4b",
"project_status_code": "sample string 10",
"project_status": {
"id": "3edb8adc-442a-4e6b-9d56-3ffb96ce4457",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "06373948-9f75-4e31-a9e7-300d278625c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"company_id": "961dcde8-acec-43f2-90f1-16f9c52086ee",
"company_code": "sample string 12",
"db_address_id": "5e9fe30d-4e42-40d1-af98-79ce82b09597",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "76f06375-71b8-4ca2-b765-cfbf7acf217b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6d5aa17d-abb3-4065-97d3-fd863edbdb83",
"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-06-05T10:39:15.6570117+00:00",
"date_create": "2026-06-05T10:39:15.6570117+00:00",
"date_update": "2026-06-05T10:39:15.6570117+00:00",
"updated_by_user_id": "725ee2fe-ebc3-447f-94a6-0f67b61a6c54",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-05T10:39:15.6570117+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-06-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-05T10:39:15.6570117+00:00",
"date_last_job": "2026-06-05T10:39:15.6570117+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-05T10:39:15.6570117+00:00",
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00",
"is_mobile_installation": true
},
"job_type_id": "487c27b3-f8ed-4a33-9fab-0fb957714467",
"job_type_code": "sample string 7",
"job_type": {
"id": "9c3c2c13-b1f3-4dc4-8dec-bc4d223e7d91",
"name": "sample string 2",
"sales_organization_id": "bfad2dc5-6eaa-458e-83ae-6a414d04c96c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00",
"code": "sample string 7"
},
"job_priority_id": "4e5fd96c-83ce-4d76-84a2-6e639fe6243d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f22c2395-3fad-4a27-a06f-a2e264889533",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "38f23fbc-4a40-4796-a548-ef333d426fef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"job_status_id": "a620e029-ade3-4b11-8cdd-d4257ec48539",
"job_status_code": "sample string 11",
"db_address_id": "505ec6b7-bc7f-4f6d-b1df-6ed16606bcee",
"contact_id": "4db560f2-8560-4f22-8bb3-8996d17b48ba",
"requested_by_company_id": "bc9d9db6-1162-48ec-8dcf-093d7dd173dc",
"requested_by_contact_id": "8be9f1d8-4eb1-4c83-a49f-db2c1253f3b7",
"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-06-05T10:39:15.6570117+00:00",
"due_date": "2026-06-05T10:39:15.6570117+00:00",
"date_create": "2026-06-05T10:39:15.6570117+00:00",
"date_update": "2026-06-05T10:39:15.6570117+00:00",
"date_closed": "2026-06-05T10:39:15.6570117+00:00",
"suggested_user_id": "e38f8493-1553-4d2e-aece-3a2a3ba32f3c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "35984a9f-35f2-4559-9835-415cf3bf30f3",
"db_language_id": "d938f447-dc1f-4623-9d1a-de825d256f4b",
"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-06-05T10:39:15.6570117+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e7518cdb-f0e7-4e87-a268-119997a27d26",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "496a7e24-3ab1-4a11-b09e-ea48900e3126",
"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": "03c01fbe-0340-47f9-b80c-c36d954b7eaf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8ed9f2c9-ddf8-432b-957c-1300d72e867d"
},
"suggested_date_start": "2026-06-05T10:39:15.6570117+00:00",
"skill_id": "12894b71-ea75-410e-88d5-defd109001dc",
"skill_code": "sample string 32",
"skill": {
"id": "8672a06d-ff9a-4eca-ab31-fa171256b45b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7954ae95-30fb-45d7-82e6-b89f359a972d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6638b3-8d95-41fe-b702-e0d3360ab2e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "09a0c8bb-75d7-4e15-9f80-1f5152252c2c",
"db_currency_id": "75ba0517-3506-4e46-9488-3d2f5dd06a12",
"db_language_id": "fd219e1b-ad47-48d1-8ba7-c6ef8ae45f50",
"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-06-05T10:39:15.6570117+00:00"
},
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "29e8a789-bfc4-4f79-8593-c108de75686f",
"date_reported_by_company": "2026-06-05T10:39:15.6570117+00:00",
"id2": 36,
"company_id": "6d2ff252-6d11-4b63-ac4a-1d0f2dc917a0",
"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": "dde987dd-b428-4da0-b588-bad53cd3de0c",
"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-06-05T10:39:15.6570117+00:00"
},
"work_instruction_details_id": "6225c757-f34e-41a9-8cde-bf6dd5bfe56e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5377dc00-a7e9-47f5-bff8-45e85e9b1329",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cdb990bd-0d08-455e-96cd-b49c86e0b384",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-05T10:39:15.6570117+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": "f0cfc85d-480e-4b53-b560-fc2052523c2f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-05T10:39:15.6570117+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.