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": "0a28102c-55d0-4b9e-ac32-786834158793",
"jobs_id": "b58c5529-6dbf-4a87-bcbf-56794620422c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b7f4f89-07ef-47ca-939a-d31f67e1d1d7",
"_parent_id": "31c98d87-5b2a-4b6f-bffe-ae8a22059ccc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cff1a97c-6828-46b4-9e02-67d69b498b8e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2e3b5f8a-ccb3-4bcf-88b1-2f2a75202edd",
"_parent_id": "3c716688-46eb-4c10-8d94-b0cf00da06f3",
"root_parent_id": "bd3810a5-4076-4464-bc9c-a008bb30ac4e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cb17d506-b593-41ff-a12f-436fb1001c03",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4378e674-fc95-4a01-91c1-f1eda21f2bd0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4facb6b5-88aa-4b2d-af18-2c9d7dbf21fc",
"_parent_code": "sample string 6",
"sales_organization_id": "953d4b80-ea0f-4c6c-bbaf-1f30550e8263",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"modified_dateutc": "2026-04-25T09:32:11.644936+00:00"
},
"equipment_model_id": "0c29bd94-1f3f-4178-9f71-771a4413f649",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "42e49c35-0ef1-4075-b14f-435a8bd544a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5afd66e5-1aa3-4476-a00b-5949e9234c34",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6549ba7c-015a-458f-80f8-43e749b8bc28",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "71869064-9125-4371-b539-f7d1889bccdc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"modified_dateutc": "2026-04-25T09:32:11.644936+00:00"
},
"equipment_family_id": "8811adf9-8e7f-49f6-b836-fd13985b69c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4378e674-fc95-4a01-91c1-f1eda21f2bd0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4facb6b5-88aa-4b2d-af18-2c9d7dbf21fc",
"_parent_code": "sample string 6",
"sales_organization_id": "953d4b80-ea0f-4c6c-bbaf-1f30550e8263",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"modified_dateutc": "2026-04-25T09:32:11.644936+00:00"
},
"date_in_production_since": "2026-04-25T09:32:11.644936+00:00",
"date_out_of_production_since": "2026-04-25T09:32:11.644936+00:00",
"date_end_support": "2026-04-25T09:32:11.644936+00:00",
"sales_organization_id": "303af037-53e4-43a8-977d-e37203834372",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+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-04-25T09:32:11.644936+00:00"
},
"project_status_id": "8e5ee8c5-97be-4c1c-b220-c85402d688ff",
"project_status_code": "sample string 10",
"project_status": {
"id": "64056f5b-0775-4eeb-a38d-96031e0cb890",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0f9f7a58-61ff-47fc-87b9-46e21d881d0b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-25T09:32:11.644936+00:00"
},
"company_id": "74c8f263-87b3-4933-8d2c-7e03be7915d3",
"company_code": "sample string 12",
"db_address_id": "38b456c4-7fc1-4b66-94c1-c79e993cac63",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "43cc7028-e172-4db1-a6dd-bf42c40bf10a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d7dfd3b-0153-4bd5-8630-5cf22536e50f",
"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-04-25T09:32:11.6605571+00:00",
"date_create": "2026-04-25T09:32:11.6605571+00:00",
"date_update": "2026-04-25T09:32:11.6605571+00:00",
"updated_by_user_id": "8929a67f-adec-4a3a-afdc-34c0adc8c9f7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-25T09:32:11.6605571+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-04-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-25T09:32:11.6605571+00:00",
"date_last_job": "2026-04-25T09:32:11.6605571+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-25T09:32:11.6605571+00:00",
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00",
"is_mobile_installation": true
},
"job_type_id": "df967e23-9fe9-4e44-9a76-fb6919b29bae",
"job_type_code": "sample string 7",
"job_type": {
"id": "d6048a42-4dfa-4ca2-b0b8-dc11aa1b2230",
"name": "sample string 2",
"sales_organization_id": "860fe443-4fa0-4fdc-8a5f-4851a078d1a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00",
"code": "sample string 7"
},
"job_priority_id": "05909309-b249-4aaa-9d2a-60544090d44d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c2770b32-b18c-45b7-8486-e22da2bd43f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4d222918-f5ee-480d-8d1a-f83273f0508e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00"
},
"job_status_id": "7c9a095c-9517-49bb-a11c-23f862a9f702",
"job_status_code": "sample string 11",
"db_address_id": "65752883-0e3c-40d9-9610-f0f47327035c",
"contact_id": "2492c1c9-97ae-4c29-8793-e12c5c7c1a25",
"requested_by_company_id": "da1fc994-142a-4f2b-8546-b8652dbd0ef3",
"requested_by_contact_id": "e66402ff-d294-4fa3-a37f-b986cd9774fd",
"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-04-25T09:32:11.6605571+00:00",
"due_date": "2026-04-25T09:32:11.6605571+00:00",
"date_create": "2026-04-25T09:32:11.6605571+00:00",
"date_update": "2026-04-25T09:32:11.6605571+00:00",
"date_closed": "2026-04-25T09:32:11.6605571+00:00",
"suggested_user_id": "b7f9d02d-3b2f-4a58-ae32-36448a74564b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c7c572bf-2a2d-44de-9ebd-800519a7b574",
"db_language_id": "0b0443cd-fafd-4104-943f-d3b846ea4312",
"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-04-25T09:32:11.6605571+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "109396c3-86cd-46dd-98fc-e530e0ff0c01",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c61d749a-5db7-4416-9ad8-c52f5fd530f2",
"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": "843ca7e4-c90e-4267-8e19-723e77012710",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3fc5a771-4d91-4f7e-8fe6-42d30e9cf788"
},
"suggested_date_start": "2026-04-25T09:32:11.6605571+00:00",
"skill_id": "eedad86b-e74f-42b0-b521-746b1404f1f0",
"skill_code": "sample string 32",
"skill": {
"id": "fa47334e-7e29-4929-9643-87753c8d2f7c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a66e3f0-140d-4f57-86f4-266dce37de4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2dd52990-9cff-4c5c-a524-4f5ee4ac6dfb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "239ff26a-76e5-4643-a5d9-797348a588c1",
"db_currency_id": "2b502657-2e91-43f1-9054-6435597f9124",
"db_language_id": "39583c65-2d0f-4305-9e11-99dec737528c",
"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-04-25T09:32:11.644936+00:00"
},
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7dced53b-a19a-4068-a81f-d32b19453354",
"date_reported_by_company": "2026-04-25T09:32:11.6605571+00:00",
"id2": 36,
"company_id": "1835167e-2186-41c3-9128-c353fefe30fa",
"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": "9471f52f-c6fc-4dc2-97ad-80e2330a8f5b",
"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-04-25T09:32:11.6605571+00:00"
},
"work_instruction_details_id": "3f8bb273-96e8-4d4b-bc73-63ca9c541c9f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7d6539c4-5b45-446e-ab21-7992b2d7c5c6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5c88c3c2-98dd-4dd0-8f9d-cd91a0ec51c5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-25T09:32:11.6605571+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": "b0a2042d-23b1-412d-a268-669701dda123",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-25T09:32:11.6605571+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.