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": "444c52b6-3c20-43a8-a4b9-8fac291a5064",
"jobs_id": "6c4c64f9-2c56-4229-bb05-c0a7daf3350c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9aacdb44-60ae-41a0-94d4-1b7596560a3e",
"_parent_id": "72fa9ffc-0721-4527-b1ba-4a71505b2061",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9bd0f959-a869-4300-84b9-e51dc3fadff2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "158fb781-b26c-4a68-b1b0-7296196954a4",
"_parent_id": "636beb1d-2588-4de4-94d7-7504ab47e2e0",
"root_parent_id": "35a961df-256d-4927-b80c-6c751bd3f1cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9108d0f7-2504-43a9-b612-340233f7cf5f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "959c6628-60b4-45b3-8ac5-de5e39a2c037",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d45335e-5546-4717-9d4f-34d62be505f2",
"_parent_code": "sample string 6",
"sales_organization_id": "3dcf6465-3f80-4d57-95ee-45994a485b47",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"equipment_model_id": "8cf7f45b-fdd2-484b-b858-2045bc226d87",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6c682846-0d6d-4cbc-aa97-de2d59874722",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e6974055-1404-427e-b8c9-64c7fe8ea9df",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "199e8b89-08f8-4b18-926a-d635d8c2785e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "424b3e45-524a-41c5-9277-29fa6884edbb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"equipment_family_id": "2ba6a872-d763-44b8-9439-e2b132885caa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "959c6628-60b4-45b3-8ac5-de5e39a2c037",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1d45335e-5546-4717-9d4f-34d62be505f2",
"_parent_code": "sample string 6",
"sales_organization_id": "3dcf6465-3f80-4d57-95ee-45994a485b47",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"date_in_production_since": "2026-06-10T13:13:55.6493877+00:00",
"date_out_of_production_since": "2026-06-10T13:13:55.6493877+00:00",
"date_end_support": "2026-06-10T13:13:55.6493877+00:00",
"sales_organization_id": "4d969979-4cbe-4627-ae12-fee4345c31b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+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-10T13:13:55.6493877+00:00"
},
"project_status_id": "57ae43d0-0d73-4ed9-95b0-fadeb1f30342",
"project_status_code": "sample string 10",
"project_status": {
"id": "c0dbec6d-9bc1-4f24-8cfb-44ca1f23503f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "173bbba6-73d9-4cf8-ba1f-6cf497b3ce55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"company_id": "ae2ec7ba-6e24-4c91-929f-eedd3925076a",
"company_code": "sample string 12",
"db_address_id": "52f7890f-c203-4521-8cbb-5c73bab60122",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2bd3386a-ac95-4d95-ac72-7f2de427af93",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d84eb8f4-023a-45cb-8887-a9b373d7fdbe",
"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-10T13:13:55.6493877+00:00",
"date_create": "2026-06-10T13:13:55.6493877+00:00",
"date_update": "2026-06-10T13:13:55.6493877+00:00",
"updated_by_user_id": "9c88250d-32fd-4007-8771-bbd8bfd97050",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-10T13:13:55.6493877+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-10T13:13:55.6493877+00:00",
"date_last_job": "2026-06-10T13:13:55.6493877+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-10T13:13:55.6493877+00:00",
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00",
"is_mobile_installation": true
},
"job_type_id": "8ed8a0c9-3ad6-4f50-bc68-9657df791e1e",
"job_type_code": "sample string 7",
"job_type": {
"id": "d7833826-4849-4de9-8389-8fd20fad67cc",
"name": "sample string 2",
"sales_organization_id": "9ff7a94e-2f32-44cc-80ab-b1a0f55f8c8d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00",
"code": "sample string 7"
},
"job_priority_id": "3651ad14-aaea-4c2f-94d4-8e28961a60d0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8e493c09-7a94-432d-8961-76d3ba4b9b2f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5e7e12d5-b42c-4eeb-9a64-194e251ef892",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"job_status_id": "85bfa580-7345-4c80-abf5-277c9b7f4576",
"job_status_code": "sample string 11",
"db_address_id": "08a644e0-9f5a-4a62-831d-0a189876f061",
"contact_id": "3980510f-216a-4eb1-bba1-a695da1d1585",
"requested_by_company_id": "b07b2138-5ffe-4279-b3af-7cf6da1085f7",
"requested_by_contact_id": "95d1f5de-cfd7-489f-9db3-123ddeae3e1b",
"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-10T13:13:55.6493877+00:00",
"due_date": "2026-06-10T13:13:55.6493877+00:00",
"date_create": "2026-06-10T13:13:55.6493877+00:00",
"date_update": "2026-06-10T13:13:55.6493877+00:00",
"date_closed": "2026-06-10T13:13:55.6493877+00:00",
"suggested_user_id": "29a28ce3-dcbb-4d5b-b70a-c15ac64d19f5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "352cda72-3132-48d4-8b0f-8547c93839bb",
"db_language_id": "5af1ee02-69ae-4107-b764-c4d50f71f3f8",
"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-10T13:13:55.6493877+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7289c79b-aa7a-45d8-91da-e48ca6980a15",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ecc09578-5d3c-4b54-aaee-adeefd52400a",
"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": "a35015e5-7bda-4e79-821b-069700d8900c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8b1faa7d-79b4-4192-9bef-c840454b5a9e"
},
"suggested_date_start": "2026-06-10T13:13:55.6493877+00:00",
"skill_id": "face7b97-c741-4310-aaa0-6c9598078806",
"skill_code": "sample string 32",
"skill": {
"id": "32d5b0da-a642-4e1a-9397-85727825c931",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "90431de8-9466-4598-9929-e75455083337",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5afa4203-b8a4-4020-8ac0-10ae88e83bad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "547d8798-1652-4dec-8fa1-832714c1c505",
"db_currency_id": "ef5c187b-c48e-4d33-9805-163ca6283bc2",
"db_language_id": "2bbea863-c4fb-4a1c-b46d-d962ec012de7",
"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-10T13:13:55.6493877+00:00"
},
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac750cce-5248-4007-a57a-778e75278dfb",
"date_reported_by_company": "2026-06-10T13:13:55.6493877+00:00",
"id2": 36,
"company_id": "d14c7f22-abb5-41bb-a63e-6b4c7d7c444e",
"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": "04b44d88-39ed-40f4-b200-f331c1852a76",
"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-10T13:13:55.6493877+00:00"
},
"work_instruction_details_id": "3fc36f21-4fa4-429e-a6a8-32b9f928115d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4b08deab-0fa5-494b-b60e-5731d23d05d5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "12a3b025-dfb1-4b40-93bc-9fb90c65e20c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-10T13:13:55.6493877+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": "6fe787e8-4bbd-4339-83b8-82c52bcfd94d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-10T13:13:55.6493877+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.