Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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": "5a6fd5f4-0f22-4305-a151-7b629172a4ce",
  "jobs_id": "59b83d1e-aa3b-46e2-a5f0-9eacd4ef8547",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "4e6d7c11-adfe-4843-87ca-83c3c6595ef0",
    "_parent_id": "5d0bb4d2-32a7-42d3-8978-39c5ef01d2e4",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "092e3309-87e6-408f-81aa-8929bddd60e3",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "e465c352-7471-4ace-94d9-e324a7097728",
      "_parent_id": "3b611c33-b4cd-4325-9a0b-739b0732604a",
      "root_parent_id": "0f395e3e-6a97-4388-95be-f8c4003e9363",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "7e403da9-a2fd-4483-8635-a79683ef4cea",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "7888d247-e046-458b-bca2-06f3f57e076c",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "08bca180-0266-4114-9c6e-28c89302b052",
        "_parent_code": "sample string 6",
        "sales_organization_id": "a6fccd0b-3bb3-4e15-af57-c156473c8e63",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
          "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
          "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
          "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": "2025-07-11T02:39:41.3112954+00:00"
        },
        "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
      },
      "equipment_model_id": "abdfd146-2ac9-46f2-b27b-05b1082b0b12",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "279924a9-a860-4688-9858-3a9d47cf34d1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "27950390-655c-49fd-9f1c-ba5f0a001314",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "bc20e329-7719-42ba-ad9e-8602e0d8b6c6",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "d507a2ea-7f6b-4b72-9b51-77e48c6a4279",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
            "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
            "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
            "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": "2025-07-11T02:39:41.3112954+00:00"
          },
          "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
        },
        "equipment_family_id": "daaca265-0d17-4e48-afc2-94e1abe6a9a4",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "7888d247-e046-458b-bca2-06f3f57e076c",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "08bca180-0266-4114-9c6e-28c89302b052",
          "_parent_code": "sample string 6",
          "sales_organization_id": "a6fccd0b-3bb3-4e15-af57-c156473c8e63",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
            "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
            "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
            "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": "2025-07-11T02:39:41.3112954+00:00"
          },
          "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
        },
        "date_in_production_since": "2025-07-11T02:39:41.3112954+00:00",
        "date_out_of_production_since": "2025-07-11T02:39:41.3112954+00:00",
        "date_end_support": "2025-07-11T02:39:41.3112954+00:00",
        "sales_organization_id": "c59a382e-2b67-426c-8d0d-ec43368ed189",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
          "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
          "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
          "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": "2025-07-11T02:39:41.3112954+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": "2025-07-11T02:39:41.3112954+00:00"
      },
      "project_status_id": "3f56d4d6-a857-4ae2-af80-eb8078808cde",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "8e5511cd-5177-468f-a1eb-9704cfaa3dc9",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "7e651c9b-8091-4054-b4fb-08366ac524ee",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
          "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
          "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
          "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": "2025-07-11T02:39:41.3112954+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
      },
      "company_id": "7077887d-5873-4fb7-bad3-339706a607c7",
      "company_code": "sample string 12",
      "db_address_id": "cbef1e73-a1d4-492d-80b3-cd699a73b8f6",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "457aaf4a-822f-47ab-b9db-fd13f6393528",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "070e4581-7b13-470e-9238-67a4d4092013",
      "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": "2025-07-11T02:39:41.3112954+00:00",
      "date_create": "2025-07-11T02:39:41.3112954+00:00",
      "date_update": "2025-07-11T02:39:41.3112954+00:00",
      "updated_by_user_id": "0f7c5b3c-e42f-4471-b2be-e2eb9cfdf0a6",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-11T02:39:41.3112954+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": "2025-07-11T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-11T02:39:41.3112954+00:00",
      "date_last_job": "2025-07-11T02:39:41.3112954+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-11T02:39:41.3112954+00:00",
      "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "2af96d12-9ad8-4638-a4ce-8a4bf0802754",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "573f5016-1350-4ad0-90e1-1ce9e04ed410",
      "name": "sample string 2",
      "sales_organization_id": "3e7a937a-631a-40de-86bd-133f33dffee6",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "ae3303ac-8046-4e1d-aa63-00e3bf91eb9f",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "dd4b4405-9c19-4470-8f76-effcf20daff7",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "d140edd9-8a11-4a69-9751-2bef2bf55375",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
        "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
        "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
        "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": "2025-07-11T02:39:41.3112954+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
    },
    "job_status_id": "da117b07-81ee-45cf-b2de-90cc68cb24c5",
    "job_status_code": "sample string 11",
    "db_address_id": "7dd52bf7-bf52-4dcf-9d4d-e19a25fb73ab",
    "contact_id": "74c27298-c4da-4407-bf69-eb78df4be4d6",
    "requested_by_company_id": "0cf25d23-94ed-462e-9a9b-c67b02b01196",
    "requested_by_contact_id": "c8b6402a-f2b0-4dca-bd6d-993f2fc1a32c",
    "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": "2025-07-11T02:39:41.3112954+00:00",
    "due_date": "2025-07-11T02:39:41.3112954+00:00",
    "date_create": "2025-07-11T02:39:41.3112954+00:00",
    "date_update": "2025-07-11T02:39:41.3112954+00:00",
    "date_closed": "2025-07-11T02:39:41.3112954+00:00",
    "suggested_user_id": "bf2ff97d-e512-40b6-a16a-ad28d4373da7",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "ceae5a87-a9ff-415d-8881-622b7b6553ac",
      "db_language_id": "169fdd1b-3239-4936-bba5-f51bf181a0fb",
      "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": "2025-07-11T02:39:41.3112954+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "31eaa29d-ba3f-40bf-97e9-1c99f90cd0fa",
      "sales_organization": {
        "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
        "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
        "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
        "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": "2025-07-11T02:39:41.3112954+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "281dff8e-96a3-4178-8b5c-86a3e67e2215",
      "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": "1981bedf-0c70-4120-a683-28ab63bd8c04",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "b0690641-2d5d-41aa-b9e2-1e863dd8bce4"
    },
    "suggested_date_start": "2025-07-11T02:39:41.3112954+00:00",
    "skill_id": "8e2ddc9f-86f2-4d58-ba4f-14652effd509",
    "skill_code": "sample string 32",
    "skill": {
      "id": "460e289a-6563-45d9-86a6-17b6df77bac9",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "38d8af12-9338-454b-9f9e-2be4cc3eb380",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "7d8fbfbd-3b7b-4bee-8d7e-d9c62baaf4fa",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "6bbc206b-b30f-4cbe-ba71-2074f82d22cd",
        "db_currency_id": "fd3edee6-cd93-46ee-9d5b-99c74af9f623",
        "db_language_id": "88529a67-83d6-4904-ae90-5437464def77",
        "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": "2025-07-11T02:39:41.3112954+00:00"
      },
      "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "b068b440-d1a1-441d-b922-848e8446d3e1",
    "date_reported_by_company": "2025-07-11T02:39:41.3112954+00:00",
    "id2": 36,
    "company_id": "835b8498-a1c5-4997-bea7-2f91519018ae",
    "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": "7f257103-3fd2-490e-a819-a3d4da1a2122",
    "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": "2025-07-11T02:39:41.3112954+00:00"
  },
  "work_instruction_details_id": "bbc584d8-ccf0-4c6b-8477-96d5b089b6dc",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "89ceded6-f6d9-4016-9790-c080467a0e84",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "91458569-373a-4a3d-ba9a-37fd79203569",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-11T02:39:41.3112954+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": "a67395fa-ece0-4647-8664-638c2836744d",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-11T02:39:41.3112954+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.