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": "491def8e-1b77-4e62-b17b-1c7ac79ce5fd",
"jobs_id": "dfecdfe4-6285-4e43-81c5-7e2dea90c671",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "557c9e01-9dff-4a62-a101-6f2e881a62e1",
"_parent_id": "60f22ed5-a990-4675-bf4f-5e3fc7af7b34",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "17eeec18-65a9-47e6-ab75-ebb388cdfc33",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dcd45bc3-5d88-4c3f-bb5e-1061997964c0",
"_parent_id": "ad67c744-ff78-4666-9805-7989c65c984c",
"root_parent_id": "103c9f5b-017d-4ffb-9d07-4e5920d5b6d6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1914d031-afa6-48fb-90ff-3f8f06cf8e46",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e929ad68-96c5-43d2-8324-59a088245ff0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dab84a29-d384-4f5a-ad57-458a2aebb429",
"_parent_code": "sample string 6",
"sales_organization_id": "66f2c7b8-a695-4c8c-a631-4d1b4ed2deb8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"equipment_model_id": "2b2defe8-303a-4506-b73c-6376e647e4c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1a0437f0-b09b-421f-874c-28bc10ca24f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ad662a86-8d02-4396-9be3-b18204a5fa80",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7ccd9f1b-78d7-45e5-a545-894a06f09e9b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "542544bf-9bbc-4acd-a91a-cc8e86ef6482",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"equipment_family_id": "460a9c49-e152-4ec5-b758-bc85e26a904d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e929ad68-96c5-43d2-8324-59a088245ff0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dab84a29-d384-4f5a-ad57-458a2aebb429",
"_parent_code": "sample string 6",
"sales_organization_id": "66f2c7b8-a695-4c8c-a631-4d1b4ed2deb8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"date_in_production_since": "2026-11-01T19:53:37.3629941+00:00",
"date_out_of_production_since": "2026-11-01T19:53:37.3629941+00:00",
"date_end_support": "2026-11-01T19:53:37.3629941+00:00",
"sales_organization_id": "c3d23f1a-b4f5-4f0c-90fb-0407a13e8377",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+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-11-01T19:53:37.3629941+00:00"
},
"project_status_id": "b433c92e-7483-4254-8257-4d57830bba1e",
"project_status_code": "sample string 10",
"project_status": {
"id": "3f2e87b5-5350-4275-bb08-1f34a94da205",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "79906756-f0ad-4764-b388-5bd0098d327d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"company_id": "f38111f7-2c9a-4b77-b752-5505225744ae",
"company_code": "sample string 12",
"db_address_id": "5b7aec5f-0660-45b1-818e-f4919d8a035d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fd6c6880-63c9-4411-b055-ba1c4118be7c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1865696a-c10e-426e-a2f5-4ded43786440",
"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-11-01T19:53:37.3629941+00:00",
"date_create": "2026-11-01T19:53:37.3629941+00:00",
"date_update": "2026-11-01T19:53:37.3629941+00:00",
"updated_by_user_id": "ef75f3f1-64e8-4481-87f5-e138a52afc75",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-01T19:53:37.3629941+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-11-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-01T19:53:37.3629941+00:00",
"date_last_job": "2026-11-01T19:53:37.3629941+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-01T19:53:37.3629941+00:00",
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00",
"is_mobile_installation": true
},
"job_type_id": "accd5d1f-78cf-40ae-a937-7d649d938664",
"job_type_code": "sample string 7",
"job_type": {
"id": "adf37b14-0282-4b29-adc9-7df7c2be181f",
"name": "sample string 2",
"sales_organization_id": "5976a447-c3b5-4501-a69b-a6170e5e14ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00",
"code": "sample string 7"
},
"job_priority_id": "97abecef-9e48-4950-ab72-c2a0f3809e98",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "273b1461-76e4-4ee3-bd4b-dc0df54f127a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "378c975b-895c-4442-b347-a46039339e3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"job_status_id": "9b6ecb2d-8177-40da-972b-4f492c8a4fee",
"job_status_code": "sample string 11",
"db_address_id": "13654bbc-9dac-4e2d-9c2b-65453b28045d",
"contact_id": "71b3ee21-7203-49c0-9f89-469e5b02e010",
"requested_by_company_id": "6dc127cf-6f30-4962-b94a-049e46307419",
"requested_by_contact_id": "14a3a196-ac3e-45ed-a3f0-79b4d807d9ab",
"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-11-01T19:53:37.3629941+00:00",
"due_date": "2026-11-01T19:53:37.3629941+00:00",
"date_create": "2026-11-01T19:53:37.3629941+00:00",
"date_update": "2026-11-01T19:53:37.3629941+00:00",
"date_closed": "2026-11-01T19:53:37.3629941+00:00",
"suggested_user_id": "1ce45d57-465f-4fd2-844a-8dbbed3c5ee5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1f5a74fb-f4d6-4307-bcc7-d6c9287a05e3",
"db_language_id": "0244d3ad-6bb7-4160-a97e-3ff6fc650863",
"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-11-01T19:53:37.3629941+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4373a296-9c5d-4edd-a745-82c6e9873270",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1f051352-e798-4ff0-9075-b2cbc269270c",
"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": "babc8293-b7cd-48c4-8629-1f3051f6a534",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "127315e4-7ecc-4acc-9969-a7f57547131a"
},
"suggested_date_start": "2026-11-01T19:53:37.3629941+00:00",
"skill_id": "5cb2b25e-0b98-494c-93c0-8a67916e5622",
"skill_code": "sample string 32",
"skill": {
"id": "e0f370c7-d316-40af-affc-2098082ab4d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e5165873-2963-4c7b-9660-d82d2909fd14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7841b73-1aa4-45a0-ae99-74e359b45e47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6c16fd-87f8-4484-93fa-933840dab754",
"db_currency_id": "52f2335d-98b4-4530-bae7-b42abc0458ae",
"db_language_id": "edc443b7-eb20-45ed-9a75-d784604e45ee",
"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-11-01T19:53:37.3629941+00:00"
},
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4a316b66-bcca-4e8a-974e-6230916c0cb7",
"date_reported_by_company": "2026-11-01T19:53:37.3629941+00:00",
"id2": 36,
"company_id": "d7e86d6d-8fc6-48d3-bd45-95b08a983e6a",
"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": "b1ff12f7-a914-4749-add5-29b12e51451d",
"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-11-01T19:53:37.3629941+00:00"
},
"work_instruction_details_id": "1df70824-f032-4f24-81ae-5a1e7a227057",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9fd3da24-ff61-43ec-9299-14f59e52d34f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a9edda0b-86b4-4c46-8f6d-3b5994befe79",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-01T19:53:37.3629941+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": "6289a8e3-e8b9-410d-9bbc-881e217a7b83",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-01T19:53:37.3629941+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.