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": "2e9a27cf-238b-4dbb-a260-bd549b8165bc",
"jobs_id": "7cc3aee7-26b1-43ff-841d-594d48f2da86",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d3dd221f-15ba-4d5e-8424-342a28c9c506",
"_parent_id": "b7cf0a99-d370-4a4c-89d5-c8ee4342e534",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "56d736b6-1412-4968-9a7e-92d38ac0c86a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "32f8377b-e010-4c12-9064-42225e79434e",
"_parent_id": "44a9c2a4-5a12-48c7-be6f-64a4ce6e968a",
"root_parent_id": "2f6bfee0-21ef-4b41-ab59-7004ae61d700",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "33453cee-e540-4b9f-9308-4cfdaedddc92",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "71a6a6a3-2af9-4be7-8532-0b7cf2b1c94c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a2926a4-f3d4-404c-bd75-2d115d4fa08c",
"_parent_code": "sample string 6",
"sales_organization_id": "59de06a2-9060-4021-b3df-2d73bdb02896",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"equipment_model_id": "0536a16c-a47d-4655-a28f-45f2fbfc1629",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "224a0b61-085c-4768-9b28-a30e67b21dcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a2c139c4-6f6a-40b7-87fb-070f8f65f01b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1bd7c74f-971a-4fad-9988-57828438ebfb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "73291cf2-f948-495e-b4d1-883656495a2e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"equipment_family_id": "741887e4-2c52-47ba-b66e-6eedeac14b57",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "71a6a6a3-2af9-4be7-8532-0b7cf2b1c94c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3a2926a4-f3d4-404c-bd75-2d115d4fa08c",
"_parent_code": "sample string 6",
"sales_organization_id": "59de06a2-9060-4021-b3df-2d73bdb02896",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"date_in_production_since": "2026-06-22T16:55:31.0214265+00:00",
"date_out_of_production_since": "2026-06-22T16:55:31.0214265+00:00",
"date_end_support": "2026-06-22T16:55:31.0214265+00:00",
"sales_organization_id": "2cd36dc7-9f8b-4a01-a1fd-45eacfd32d23",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+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-22T16:55:31.0214265+00:00"
},
"project_status_id": "0bed594d-349b-4464-ba96-51071884d1d1",
"project_status_code": "sample string 10",
"project_status": {
"id": "411feba9-1988-472b-b5c2-706b6a7b96a4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8fbc6e2-3211-4715-a11e-276f7885bd67",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"company_id": "8d8d653f-e31d-4386-9f79-be3188c184be",
"company_code": "sample string 12",
"db_address_id": "90f476b6-e460-4d68-a442-7bdef98a5e47",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00d75c06-e930-499f-bc22-e8063bf54e4a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4844b34e-0149-4ba1-8829-a8407bb83ef2",
"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-22T16:55:31.0214265+00:00",
"date_create": "2026-06-22T16:55:31.0214265+00:00",
"date_update": "2026-06-22T16:55:31.0214265+00:00",
"updated_by_user_id": "dde805cb-f055-4f8c-be59-8c53d7e98164",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-22T16:55:31.0214265+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-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-22T16:55:31.0214265+00:00",
"date_last_job": "2026-06-22T16:55:31.0214265+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-22T16:55:31.0214265+00:00",
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00",
"is_mobile_installation": true
},
"job_type_id": "dc493f2f-a14e-437b-aa1e-7e03d200ee08",
"job_type_code": "sample string 7",
"job_type": {
"id": "8861e09e-59aa-4304-9849-1704b59439e7",
"name": "sample string 2",
"sales_organization_id": "4254875b-4d37-4db2-9a4d-bea3968f9bdd",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00",
"code": "sample string 7"
},
"job_priority_id": "566c9d4e-022f-48f4-aa27-9c69ae1fa303",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4430c692-7467-4619-8a3b-9e243c4719c2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "95d127f2-cdeb-45e2-b897-13c8a4779489",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"job_status_id": "9e1aca75-dab5-4693-aa15-469c9e901909",
"job_status_code": "sample string 11",
"db_address_id": "49353516-6539-4ca7-a9ce-beb9153ddd85",
"contact_id": "17b97ac2-e92f-42d3-8705-3dbfd9e2f37e",
"requested_by_company_id": "d2fe3115-813d-4822-b85b-a3ac925febd5",
"requested_by_contact_id": "9529382b-4039-48a0-9931-2946224f6f1c",
"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-22T16:55:31.0214265+00:00",
"due_date": "2026-06-22T16:55:31.0214265+00:00",
"date_create": "2026-06-22T16:55:31.0214265+00:00",
"date_update": "2026-06-22T16:55:31.0214265+00:00",
"date_closed": "2026-06-22T16:55:31.0214265+00:00",
"suggested_user_id": "e685ce78-661d-4e97-940a-e7c4e897d3be",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "94a07e8a-8eaf-42dc-a5c2-d2bbeb493b07",
"db_language_id": "4866da3c-7607-4afd-8463-8a2d4a5dc17e",
"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-22T16:55:31.0214265+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cd68609a-6d99-4d09-b755-e2b5ca50df4b",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2d817e6-aa10-4d52-81bf-7aafbaaf17e1",
"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": "c45129f9-6eb2-42e7-a905-d5160102358b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b4d5d5dd-cfd9-44b8-b678-e34d56dc2787"
},
"suggested_date_start": "2026-06-22T16:55:31.0214265+00:00",
"skill_id": "4382b9fc-8e26-4502-bb10-47cc0527e7f0",
"skill_code": "sample string 32",
"skill": {
"id": "5177dcaf-4dc9-4ccf-a85a-0ad2e5016834",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "51a4833a-4afe-4f5a-8e87-99498baa7cb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7040d638-a296-43bc-a6f3-e821935a69ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2935352e-4a1e-4dc4-bd4b-141f729d9a76",
"db_currency_id": "91b5d82b-879d-45f6-8508-8cb1dde2f3f2",
"db_language_id": "67fa0605-002d-41bf-8e30-36e782a36c93",
"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-22T16:55:31.0214265+00:00"
},
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c2a349b-c9a7-464d-951e-ac494bb97652",
"date_reported_by_company": "2026-06-22T16:55:31.0214265+00:00",
"id2": 36,
"company_id": "adbf1bbe-28e3-4a04-8da8-8fea3f52c433",
"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": "dade1ed3-df7a-4605-9a4b-4ec7e18c7ca6",
"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-22T16:55:31.0214265+00:00"
},
"work_instruction_details_id": "a9b1c250-c493-4144-b6e5-fde37f4b3895",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fe386a07-f035-4321-a045-61e2b518e72e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6d864070-717c-46c6-8cd3-a43bc4209412",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-22T16:55:31.0214265+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": "33582274-c4d0-458d-b382-e97456bdd5e6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-22T16:55:31.0214265+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.