TaskService Resource

A set of services related to tasks.

GET /v1/task/downloadProgram

Download a .zip-file containing all files associated with the supplied task_id - if no files exists, a .zip-file without entries will be returned. All negative responses are delivered through a StatusMessage.

Request Parameters
name type description constraints
auth-token header The authentication token.  
task_id query A numeric ID describing the assignment. required int
wcu-id query A numeric ID describing the associated wcu (Note! wcu_id is only required for SignalReader tasks - use 0 otherwise) required int
Response Body
media type data type description
application/octet-stream object The requested compilation as a .zip file.

Example

Request
GET /v1/task/downloadProgram
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...

GET /v1/task/list

Returns all tasks the calling user has permission on.

Request Parameters
name type description
auth-token header The authentication token.
Response Body
media type data type description
application/json map of AssignmentType (JSON)

Example

Request
GET /v1/task/list
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
"mcdhub"

GET /v1/task/{task_id}

Returns general info about a task.

Request Parameters
name type description constraints
auth-token header The authentication token.  
task_id path The taskID of interest. required int
wcu-id query The wcuID of interest.  
Response Codes
code condition
400 If the provided task and/or wcu do not exist.
401 If the requesting user does not have permission to view the task.
Response Body
media type data type description
application/json TaskInfo (JSON)

Example

Request
GET /v1/task/{task_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "taskID" : 1234,
  "wcuID" : "04-1B-94-00-1D-2A",
  "type" : "mqtt",
  "assignmentName" : "Trigger_test",
  "taskCreatorID" : "user123",
  "status" : {
    "code" : 2,
    "text" : "RUNNING"
  },
  "lastUploadDate" : "2024-03-14T09:31:06Z",
  "creationDate" : "2024-03-12T11:31:06Z"
}

POST /v1/task/create/idc

Creates tasks of type IDC. The multipart form data input is expected to have the following fields:

  • "wcus", A list of WCU IDs for which this assignment should be run.
  • "file", The measurement description file which is run by IDC. Note! The description file needs to be correctly mapped with respect to CAN buses as no auto mapping is performed.
  • "schedule_file", A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly. The task can either be scheduled using this parameter OR by setting the asap field below. Setting both will result in a bad request response. This field is optional.
  • "asap", A boolean which is to be set to true if the task is to be performed once and as soon as possible. This field can only be set if the field above is left empty, setting both results in a bad request response This field is optional.
All negative responses are delivered through a StatusMessage.

Request Parameters
name type description constraints multivalued
asap formdata required boolean no
file formdata   no
scheduleFile formdata   no
wcus formdata   yes
auth-token header The authentication token.   no
Request Body
media type data type description
multipart/form-data (custom) Creates tasks of type IDC. The multipart form data input is expected to have the following fields:
  • "wcus", A list of WCU IDs for which this assignment should be run.
  • "file", The measurement description file which is run by IDC. Note! The description file needs to be correctly mapped with respect to CAN buses as no auto mapping is performed.
  • "schedule_file", A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly. The task can either be scheduled using this parameter OR by setting the asap field below. Setting both will result in a bad request response. This field is optional.
  • "asap", A boolean which is to be set to true if the task is to be performed once and as soon as possible. This field can only be set if the field above is left empty, setting both results in a bad request response This field is optional.
All negative responses are delivered through a StatusMessage.
Response Codes
code condition
200 IDC tasks successfully created.
400 If the field "wcus" is not populated
400 If the field "file" is not populated
400 If both the fields "schedule_file" and "asap" are populated.
400 Unable to parse ics file due to:
  • 0 or more than 1 VEVENT
  • no DTSTART in VEVENT
  • no UNTIL, INTERVAL and/or FREQ in RRULE
  • 0 INTERVAL in RRULE
400 Invalid schedule format due to:
  • schedule start after schedule end (DTSTART>DTEND)
  • schedule start after until for recurrence (DTSTART>UNTIL)
  • schedule end after until for recurrence (DTEND>UNTIL)
  • schedule time span larger than interval for recurrence (DTEND-DTSTART>INTERVAL in unit FREQ)
401 If unauthorized to create assignment.
404 If one of the supplied wcus is not found.
412 If one of the WCUs is not compatible with the task settings. The se.alkit.sr.model.StatusMessage will then contain a list of se.alkit.sr.model.ValidationError (see JSON model) describing the errors for each incompatible WCU.
500 If an exception is thrown.
Response Body
media type data type description
application/vnd.se.alkit.wice.task-v1+json Tasks (JSON) se.alkit.sr.model.Tasks

Example

Request
POST /v1/task/create/idc
Content-Type: multipart/form-data
Accept: application/vnd.se.alkit.wice.task-v1+json
auth-token: ...

                
-----boundary
Content-Disposition: form-data; name="asap"

...
-----boundary
Content-Disposition: form-data; name="file"

...
-----boundary
Content-Disposition: form-data; name="scheduleFile"

...
-----boundary
Content-Disposition: form-data; name="wcus"

...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.task-v1+json

                
{
  "map" : {
    "1001" : [ {
      "wcu-id" : "wcu_A",
      "vin" : "vin22"
    } ],
    "1002" : [ {
      "wcu-id" : "wcu_B",
      "vin" : "vin55"
    }, {
      "wcu-id" : "wcu_C",
      "vin" : "vin77"
    } ]
  }
}

CURL request

One WCU

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'file=@"/mnt/c/projects/alkit/m2m/resources/test/idc.seq"' \
--form 'wcus="m2m_wcu_2_53_1"' \
/m2m/v1/task/create/idc

CURL request

Two WCUs plus schedule

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'file=@"/mnt/c/projects/alkit/m2m/resources/test/idc.seq"' \
--form 'wcus="m2m_wcu_2_53_1"' \
--form 'wcus="m2m_wcu_2_53_1_nr2"' \
--form 'schedule_file=@"/mnt/c/projects/alkit/m2m/resources/test/schedule_time_span_local.ics"' \
/m2m/v1/task/create/idc

POST /v1/task/create/signalreader

Creates tasks of type Signal Reader.

The multipart form data input is expected to have the following fields:
  • One of
    • "vins", A list of VIN numbers for which this assignment should be run.
    • "wcus", A list of WCU IDs for which this assignment should be run.
  • One of
    • "automaticMapping", See request parameters below.
    • "manualMapping",See request parameters below.
    • "mappings", See request parameters below.
  • At most one of
    • "asap", A boolean which is to be set to true if the task is to be performed once and as soon as possible.
    • "scheduleFile", A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly.
  • Either
    • "assignmentName", A string matching a SignalReader assigment created in the assignment creator
    • Or all of
      • "hafFile", The haf file.
      • "seqFiles", If any sequence file(s) are referenced in the haf file, these should be uploaded as well.
      • "seqFilesData", A list of SequenceFileData if any sequence file are uploaded.
  • [Optional] "isEcuSwVersionValidationEnabled", If checked, before running the task, the WCU will validate that the ECU SW version of the ECUS used match the corresponding versions used for this assignment.
  • [Optional] "signals", A list of signals to monitor in realtime.
  • [Optional] "serverTriggers", A list of server triggers for the assignment.
  • [Optional] "description", A textual description which will be associated with the task.

Request Parameters
name type description constraints multivalued
asap formdata A boolean which is to be set to true if the task is to be performed once and as soon as possible. This field can only be set if the field above is left empty, setting both results in a bad request response This field is optional. required boolean no
assignmentName formdata   no
automaticMapping formdata (true|false) If the uploaded haf file should be automatically remapped (if needed) in terms of can bus mappings. required boolean no
cars formdata A list of VIN   yes
description formdata A textual description which will be associated with the task.   no
hafFile formdata   no
isEcuSwVersionValidationEnabled formdata required boolean no
manualMapping formdata (true|false) If the uploaded haf file has been manually rewriten in terms of can bus mappings. required boolean no
mappings formdata A key-value map where the key is the WCU ID and the value is a list of CANBusMapping.   no
scheduleFile formdata A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly. The task can either be scheduled using this parameter OR by setting the asap field below. Setting both will result in a bad request response.   no
seqFiles formdata   yes
seqFilesData formdata A list of SequenceFileData if any sequence files are referenced in the uploaded haf file.   yes
serverTriggers formdata A list of ServerTrigger.   yes
signals formdata A list of signals to monitor in realtime.   yes
wcus formdata A list of WCU IDs   yes
auth-token header The authentication token.   no
Request Body
media type data type description
multipart/form-data (custom) Creates tasks of type Signal Reader.

The multipart form data input is expected to have the following fields:
  • One of
    • "vins", A list of VIN numbers for which this assignment should be run.
    • "wcus", A list of WCU IDs for which this assignment should be run.
  • One of
    • "automaticMapping", See request parameters below.
    • "manualMapping",See request parameters below.
    • "mappings", See request parameters below.
  • At most one of
    • "asap", A boolean which is to be set to true if the task is to be performed once and as soon as possible.
    • "scheduleFile", A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly.
  • Either
    • "assignmentName", A string matching a SignalReader assigment created in the assignment creator
    • Or all of
      • "hafFile", The haf file.
      • "seqFiles", If any sequence file(s) are referenced in the haf file, these should be uploaded as well.
      • "seqFilesData", A list of SequenceFileData if any sequence file are uploaded.
  • [Optional] "isEcuSwVersionValidationEnabled", If checked, before running the task, the WCU will validate that the ECU SW version of the ECUS used match the corresponding versions used for this assignment.
  • [Optional] "signals", A list of signals to monitor in realtime.
  • [Optional] "serverTriggers", A list of server triggers for the assignment.
  • [Optional] "description", A textual description which will be associated with the task.
Response Codes
code condition
200 task successfully created.
400 Bad Request - please see the detailed message.
401 If unauthorized to create assignment.
404 If one of the referenced objects is not found - please see the detailed message.
412 Precondition Failed - please see the detailed message.
500 If an exception is thrown.
Response Body
media type data type description
application/vnd.se.alkit.wice.task-v1+json Tasks (JSON)

Example

Request
POST /v1/task/create/signalreader
Content-Type: multipart/form-data
Accept: application/vnd.se.alkit.wice.task-v1+json
auth-token: ...

                
-----boundary
Content-Disposition: form-data; name="asap"

...
-----boundary
Content-Disposition: form-data; name="assignmentName"

...
-----boundary
Content-Disposition: form-data; name="automaticMapping"

...
-----boundary
Content-Disposition: form-data; name="cars"

...
-----boundary
Content-Disposition: form-data; name="description"

...
-----boundary
Content-Disposition: form-data; name="hafFile"

...
-----boundary
Content-Disposition: form-data; name="isEcuSwVersionValidationEnabled"

...
-----boundary
Content-Disposition: form-data; name="manualMapping"

...
-----boundary
Content-Disposition: form-data; name="mappings"

...
-----boundary
Content-Disposition: form-data; name="scheduleFile"

...
-----boundary
Content-Disposition: form-data; name="seqFiles"

...
-----boundary
Content-Disposition: form-data; name="seqFilesData"

...
-----boundary
Content-Disposition: form-data; name="serverTriggers"

...
-----boundary
Content-Disposition: form-data; name="signals"

...
-----boundary
Content-Disposition: form-data; name="wcus"

...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.task-v1+json

                
{
  "map" : {
    "1001" : [ {
      "wcu-id" : "wcu_A",
      "vin" : "vin22"
    } ],
    "1002" : [ {
      "wcu-id" : "wcu_B",
      "vin" : "vin55"
    }, {
      "wcu-id" : "wcu_C",
      "vin" : "vin77"
    } ]
  }
}

CURL request

HafFile with no sequence

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/0seq.haf"' \
--form 'manualMapping="true"' \
/m2m/v1/task/create/signalreader

CURL request

HafFile with one sequence

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/1seq.haf"' \
--form 'seqFiles=@"/mnt/c/projects/alkit/m2m/resources/test/seq/idc.seq"' \
--form 'seqFilesData=[{"fileName":"idc.seq","hafMapping":"SPA_180.seq","readExtendedData":"true","readSnapshot":"true"}];type=application/json' \
--form 'manualMapping="true"' \
/m2m/v1/task/create/signalreader

CURL request

HafFile with two sequences

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/2seq.haf"' \
--form 'seqFiles=@"/mnt/c/projects/alkit/m2m/resources/test/seq/idc.seq"' \
--form 'seqFiles=@"/mnt/c/projects/alkit/m2m/resources/test/seq/idc2.seq"' \
--form 'seqFilesData=[{"fileName":"idc.seq","hafMapping":"13w35_VEP_VPb_20130528_withoutBCM.seq","readExtendedData":"false","readSnapshot":"true"}, {"fileName":"idc2.seq","hafMapping":"13w35_VEP_VPb_20130528.seq","readExtendedData":"false","readSnapshot":"true"}];type=application/json' \
--form 'manualMapping="true"' \
/m2m/v1/task/create/signalreader

CURL request

Triggers

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/0seq.haf"' \
--form 'manualMapping="true"' \
--form 'serverTriggers=[{"label":"LABEL1","signalsInExpression":["CAN_HS.LongAcceleration"],"triggerExpression":"CAN_HS.LongAcceleration > 1"},{"label":"LABEL2","signalsInExpression":["MX_4_T20_Internal.Busload_CAN_2_0001"],"triggerExpression":"MX_4_T20_Internal.Busload_CAN_2_0001 > 2"}];type=application/json' \
/m2m/v1/task/create/signalreader

CURL request

Signals

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/0seq.haf"' \
--form 'manualMapping="true"' \
--form 'signals=["CAN_HS.LongAcceleration", "MX_4_T20_Internal.Busload_CAN_2_0001"];type=application/json' \
/m2m/v1/task/create/signalreader

CURL request

Mappings WCU

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1", "m2m_wcu_2_53_1_nr2"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/0seq.haf"' \
--form 'mappings={"m2m_wcu_2_53_1":[{"from":"CAN1","to":"CAN1"},{"from":"CAN2","to":"ignore"}],"m2m_wcu_2_53_1_nr2":[{"from":"CAN1","to":"ignore"},{"from":"CAN2","to":"ignore"}]};type=application/json' \
/m2m/v1/task/create/signalreader

CURL request

Mappings VIN

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'vins=["m2m_car_1", "m2m_car_2"];type=application/json' \
--form 'hafFile=@"/mnt/c/projects/alkit/m2m/resources/test/haf/0seq.haf"' \
--form 'mappings={"m2m_car_1":[{"from":"CAN1","to":"CAN1"},{"from":"CAN2","to":"ignore"}],"m2m_car_2":[{"from":"CAN1","to":"ignore"},{"from":"CAN2","to":"ignore"}]};type=application/json' \
/m2m/v1/task/create/signalreader

POST /v1/task/create/soh

Creates tasks of type state of health (SoH)

This assignment type is used to monitor diagnostic car parameters, such as for instance mileage.

The multipart form data input is expected to have the following fields:
  • "vins", A list of VIN numbers for which this assignment should be run. You must supply either this list or the one below. Populating both will result in a bad request response. This field is optional.
  • "wcus", A list of WCU IDs for which this assignment should be run. You must supply either this list or the one above. Populating both will result in a bad request response. This field is optional.
  • "diagnostics", A list of diagnostic option parameters of type SohDiagnosticOption to be measured. You must supply at least one.
  • "read_ecu_dtc", Additional settings for the diagnostic option of type SohReadECUDTC. You must supply this if and only if the forementioned diagnostic option is added to the list above, otherwise the response will be a bad request. This field is optional.
  • "description", A textual description which will be associated with the task. This field is optional.
  • "schedule_file", A schedule file in iCalendar format of type .ics used to schedule the task. It must have one and only one VEVENT field with DTSTART set. If DTEND is set the task will be performed in the span DTSTART to DTEND. To repeat the task define the RRULE field accordingly. The task can either be scheduled using this parameter OR by setting the asap field below. Setting both will result in a bad request response. This field is optional.
  • "asap", A boolean which is to be set to true if the task is to be performed once and as soon as possible. This field can only be set if the field above is left empty, setting both results in a bad request response This field is optional.
All negative responses are delivered through a StatusMessage.

Request Parameters
name type description constraints multivalued
asap formdata required boolean no
description formdata   no
diagnostics formdata "APP_DIAGNOSTIC_DB_PART_NUM" or "BATTERY_VOLTAGE" or "MILEAGE" or "READ_ECU_DTCS" or "READ_ECU_SOFTWARE_NUMBERS" or "READ_OBD_II_PIDS" yes
read_ecu_dtc formdata   no
schedule_file formdata   no
vins formdata   yes
wcus formdata   yes
auth-token header The authentication token.   no
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
200 SoH tasks successfully created.
400 If both the fields "wcus" and "vins" are populated.
400 If both the fields "diagnostics" is not populated
400 If the field "diagnostics" contains SohDiagnosticOption#READ_ECU_DTCS but "read_ecu_dtc" is not populated.
400 If the field "read_ecu_dtc" is populated but "diagnostics" does not contain SohDiagnosticOption#READ_ECU_DTCS.
400 If both the fields "schedule_file" and "asap" are populated.
400 Unable to parse ics file due to:
  • 0 or more than 1 VEVENT
  • no DTSTART in VEVENT
  • no UNTIL, INTERVAL and/or FREQ in RRULE
  • 0 INTERVAL in RRULE
400 Invalid schedule format due to:
  • schedule start after schedule end (DTSTART>DTEND)
  • schedule start after until for recurrence (DTSTART>UNTIL)
  • schedule end after until for recurrence (DTEND>UNTIL)
  • schedule time span larger than interval for recurrence (DTEND-DTSTART>INTERVAL in unit FREQ)
412 If one of the supplied cars is not connected to a WCU.
412 If one of the WCUs is not compatible with the task settings. The se.alkit.sr.model.StatusMessage will then contain a list of se.alkit.sr.model.ValidationError (see JSON model) describing the errors for each incompatible WCU.
404 If one of the supplied cars is not found.
404 If one of the supplied wcus is not found.
Response Body
media type data type description
application/vnd.se.alkit.wice.task-v1+json Tasks (JSON) se.alkit.sr.model.Tasks

Example

Request
POST /v1/task/create/soh
Content-Type: multipart/form-data
Accept: application/vnd.se.alkit.wice.task-v1+json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.task-v1+json

                
{
  "map" : {
    "1001" : [ {
      "wcu-id" : "wcu_A",
      "vin" : "vin22"
    } ],
    "1002" : [ {
      "wcu-id" : "wcu_B",
      "vin" : "vin55"
    }, {
      "wcu-id" : "wcu_C",
      "vin" : "vin77"
    } ]
  }
}

POST /v1/task/create/swdl

Creates tasks of type SWDL.

This type of assignment is used to update the software in ECUs in the car. A set of vbf files are used to update the ECUs. Multiple cars and/or ECUs can be updated simultaneously by supplying multiple vbf files and VIN identifiers for the cars.

The multipart form data input is expected to have the following fields:
  • "vins", A list of VIN numbers for which this assignment should be run. You must supply either this list or the one below. Populating both will result in a bad request response. This field is optional.
  • "wcus", A list of WCU IDs for which this assignment should be run. You must supply either this list or the one above. Populating both will result in a bad request response. This field is optional.
  • "filePins", A list of VbfFilePin. It this list is empty or if any pin code is empty, a bad request response is returned.
  • "description", A textual description which will be associated with the task. This field is optional.
  • "checksumFile", A checksum file. This field is optional.
  • "vgmPin", VGM unlock. It this is present and invalid, a bad request response is returned. This field is optional.
  • "ignoreChecksums", Ignore checksums. This field is optional.
  • "disablePreProgramming", Disable pre-programming. This field is optional.
All negative responses are delivered through a StatusMessage.

Request Parameters
name type description default constraints multivalued
cars formdata     yes
checksumFile formdata     no
description formdata     no
disablePreProgramming formdata false boolean no
filePins formdata     yes
ignoreChecksums formdata false boolean no
vgmPin formdata     no
wcus formdata     yes
auth-token header The authentication token.     no
Request Body
media type data type description
multipart/form-data (custom) Creates tasks of type SWDL.

This type of assignment is used to update the software in ECUs in the car. A set of vbf files are used to update the ECUs. Multiple cars and/or ECUs can be updated simultaneously by supplying multiple vbf files and VIN identifiers for the cars.

The multipart form data input is expected to have the following fields:
  • "vins", A list of VIN numbers for which this assignment should be run. You must supply either this list or the one below. Populating both will result in a bad request response. This field is optional.
  • "wcus", A list of WCU IDs for which this assignment should be run. You must supply either this list or the one above. Populating both will result in a bad request response. This field is optional.
  • "filePins", A list of VbfFilePin. It this list is empty or if any pin code is empty, a bad request response is returned.
  • "description", A textual description which will be associated with the task. This field is optional.
  • "checksumFile", A checksum file. This field is optional.
  • "vgmPin", VGM unlock. It this is present and invalid, a bad request response is returned. This field is optional.
  • "ignoreChecksums", Ignore checksums. This field is optional.
  • "disablePreProgramming", Disable pre-programming. This field is optional.
All negative responses are delivered through a StatusMessage.
Response Codes
code condition
200 SWDL tasks successfully created.
400 If both/neither of the fields "wcus" and "vins" are populated.
400 If "filePins" is not populated.
400 If any "filePins" contains an invalid pin code.
400 If "vgmPin" is invalid.
400 If any file identifier is mapped more than once in any "filePins".
401 If unauthorized to create assignment.
404 If one of the supplied filePin identifiers is not uploaded beforehand.
404 If one of the supplied cars/wcus is not found.
412 If one of the supplied cars is not connected to a WCU.
412 If one of the WCUs is not compatible with the task settings. The se.alkit.sr.model.StatusMessage will then contain a list of se.alkit.sr.model.ValidationError (see JSON model) describing the errors for each incompatible WCU.
500 If an exception is thrown.
Response Body
media type data type description
application/vnd.se.alkit.wice.task-v1+json Tasks (JSON) se.alkit.sr.model.Tasks

Example

Request
POST /v1/task/create/swdl
Content-Type: multipart/form-data
Accept: application/vnd.se.alkit.wice.task-v1+json
auth-token: ...

                
-----boundary
Content-Disposition: form-data; name="cars"

...
-----boundary
Content-Disposition: form-data; name="checksumFile"

...
-----boundary
Content-Disposition: form-data; name="description"

...
-----boundary
Content-Disposition: form-data; name="disablePreProgramming"

...
-----boundary
Content-Disposition: form-data; name="filePins"

...
-----boundary
Content-Disposition: form-data; name="ignoreChecksums"

...
-----boundary
Content-Disposition: form-data; name="vgmPin"

...
-----boundary
Content-Disposition: form-data; name="wcus"

...
Response
HTTP/1.1 200 OK
Content-Type: application/vnd.se.alkit.wice.task-v1+json

                
{
  "map" : {
    "1001" : [ {
      "wcu-id" : "wcu_A",
      "vin" : "vin22"
    } ],
    "1002" : [ {
      "wcu-id" : "wcu_B",
      "vin" : "vin55"
    }, {
      "wcu-id" : "wcu_C",
      "vin" : "vin77"
    } ]
  }
}

CURL request

One WCU, one filePin

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1"];type=application/json' \
--form 'filePins=[{"pin":"11:11:11:11:11","fileIdentifiers":["ea9b72e9-533c-4f31-94ed-78499e50a42a"]}];type=application/json' \
--form 'checksumFile=@"/mnt/c/projects/alkit/m2m/resources/test/swdl_checksum.xml"' \
--form 'vgmPin="33:33:33:33:33"' \
--form 'description="SWDL DESCRIPTION"' \
--form 'ignoreChecksums="true"' \
--form 'disablePreProgramming="true"' \
/m2m/v1/task/create/swdl

CURL request

Two WCUs, two filePins

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'wcus=["m2m_wcu_2_53_1","m2m_wcu_2_53_1_nr2"];type=application/json' \
--form 'filePins=[{"pin":"11:11:11:11:11","fileIdentifiers":["ea9b72e9-533c-4f31-94ed-78499e50a42a"]},{"pin":"22:22:22:22:22","fileIdentifiers":["d235e483-50ef-407a-bbc7-816d5c7091cc"]}];type=application/json' \
/m2m/v1/task/create/swdl

CURL request

Two Vins, two filePins

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'vins=["m2m_car_1","m2m_car_2"];type=application/json' \
--form 'filePins=[{"pin":"11:11:11:11:11","fileIdentifiers":["ea9b72e9-533c-4f31-94ed-78499e50a42a"]},{"pin":"22:22:22:22:22","fileIdentifiers":["d235e483-50ef-407a-bbc7-816d5c7091cc"]}];type=application/json' \
/m2m/v1/task/create/swdl

GET /v1/task/list/{type}

Returns all tasks of the given type that the calling user has permission on.

Request Parameters
name type description constraints
auth-token header The authentication token.  
type path required
Response Body
media type data type description
application/json array of number (JSON)

Example

Request
GET /v1/task/list/{type}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/task/servertrigger/task

Returns the server triggers for the given task running on the given wcu

Request Parameters
name type description constraints
auth-token header The authentication token.  
task_id query required int
wcu-id query required int
Response Body
media type data type description
application/json array of ServerTrigger (JSON)

Example

Request
GET /v1/task/servertrigger/task
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "triggerExpression" : "...",
  "signalsInExpression" : [ "...", "..." ],
  "id" : 12345,
  "label" : "..."
} ]

POST /v1/task/upload/vbf

Uploads one or more VBF file and returns an UUID mapping for each supplied file.

The returned UUID:s can be used when specifying file identifiers for "filePins" in POST TaskService.

The multipart form data input is expected to have the following fields:
  • "files", The VBF files.
All negative responses are delivered through a StatusMessage.

Request Parameters
name type description multivalued
files formdata yes
auth-token header The authentication token. no
Request Body
media type data type description
multipart/form-data (custom) Uploads one or more VBF file and returns an UUID mapping for each supplied file.

The returned UUID:s can be used when specifying file identifiers for "filePins" in POST TaskService.

The multipart form data input is expected to have the following fields:
  • "files", The VBF files.
All negative responses are delivered through a StatusMessage.
Response Codes
code condition
200 files successfully uploaded.
400 If "files" is not populated.
400 If a filename is duplicated in "files".
400 If any file in "files" is not a valid VBF file.
500 If an exception is thrown.
Response Body
media type data type description
application/json UploadFilesResult (JSON) se.alkit.sr.model.UploadFilesResult

Example

Request
POST /v1/task/upload/vbf
Content-Type: multipart/form-data
Accept: application/json
auth-token: ...

                
-----boundary
Content-Disposition: form-data; name="files"

...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "map" : {
    "uploaded_vbf_file_name1.vbf" : "d949c4c1-af09-4fde-9e93-f673f5281001",
    "uploaded_vbf_file_name2.vbf" : "16f8fef1-493e-4095-a377-3b1cf5ed0524"
  }
}

CURL request

One file

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'files=@"/mnt/c/projects/alkit/m2m/resources/test/vbf/1a71.vbf"' \
/m2m/v1/task/upload/vbf

CURL request

Two files

curl --location --request POST \
--header 'Content-Type:multipart/form-data' \
--header 'auth-token:85f0bb7a-f3cb-43d6-a8f1-56ed0a5f49f3' \
--form 'files=@"/mnt/c/projects/alkit/m2m/resources/test/vbf/1a71.vbf"' \
--form 'files=@"/mnt/c/projects/alkit/m2m/resources/test/vbf/sbl_1401.vbf"' \
/m2m/v1/task/upload/vbf

GET /v1/task/{task_id}/type

This service returns the type of the provided assignment (task) id.

Request Parameters
name type description constraints
auth-token header The authentication token.  
task_id path required int
Response Codes
code condition
400 The task id does not exist.
Response Body
media type data type description
application/json AssignmentType (JSON)

Example

Request
GET /v1/task/{task_id}/type
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
"mcdhub"

GET /v1/task/status/{task_id}/car/{car_id}

Returns the status for an assignment running on the specified car.

Request Parameters
name type description constraints
auth-token header The authentication token.  
car_id path A VIN identifying the car. required
task_id path A numeric ID describing the assignment. required int
Response Body
media type data type description
application/json Assignment (JSON)

Example

Request
GET /v1/task/status/{task_id}/car/{car_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "wcu" : {
    "oid" : 12345,
    "id" : "...",
    "name" : "..."
  },
  "car" : "...",
  "status" : {
    "code" : 2,
    "text" : "RUNNING"
  },
  "message" : "..."
}

PUT /v1/task/stop/{task_id}/car/{car_id}

Request Parameters
name type description constraints
auth-token header The authentication token.  
car_id path required
task_id path required int
Response Body
media type data type description
application/json object (JSON)

Example

Request
PUT /v1/task/stop/{task_id}/car/{car_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /v1/task/result/count/{task_id}/car/{car_id}

Request Parameters
name type description constraints
auth-token header The authentication token.  
car_id path required
task_id path required int
from query long
to query long
Response Body
media type data type description
application/json object (JSON)

Example

Request
GET /v1/task/result/count/{task_id}/car/{car_id}
Content-Type: */*
Accept: application/json
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

GET /v1/task/result/file/{task_id}/car/{car_id}

Request Parameters
name type description constraints
auth-token header The authentication token.  
car_id path required
task_id path required int
from query long
to query long
Response Body
media type data type description
application/octet-stream object

Example

Request
GET /v1/task/result/file/{task_id}/car/{car_id}
Content-Type: */*
Accept: application/octet-stream
auth-token: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/octet-stream

                
...