Create reception settings

This is an API function to create reception settings. This API function corresponds to the [Reception Settings] operation on the screen that is displayed by selecting a profile after selecting the [Profile] on the operation screen of Manager.

= Remarks =

The request parameters in JSON format of the following API functions are the same.

  • Create reception settings
  • Modify reception settings details

The response parameters of the following API functions are the same.

  • Create reception settings
  • Modify reception settings details
  • Acquire reception settings details
Format
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIKEY'
             -d 'REQUESTBODYINJSONFORMAT'
             'http://HOSTNAME:PORTNUMBER/api/v1/profiles/profileId/receiving-profiles'
Request body (JSON format)
{
　　　"fileName": "string",
　　　"jobExecMode": 0,
　　　"jobScript": "string",
　　　"receivingProfileName": "string"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
File Name at Send Destination fileName String

Specify the file name to use when Agent receives the file on the IoT equipment, by using the full path of the file storage location on the IoT equipment.

Maximum 256-byte character string (*?"<>| are not available to use)

 Impossible to omit

Job Execution Mode

(Reception Settings)

 jobExecMode Integer

Specify whether jobs that are run after a distribution file was received successfully are executed at the level of scripts or steps.

0 | 1

•　0: Script Execution

•　1: Step Execution

 0
Contents of Job jobScript String

Describe jobs that are executed after a distribution file is received successfully.

Maximum 2048 ASCII characters (without NULL)

  
Reception Settings Name receivingProfileName String

Maximum 64 characters

 Impossible to omit
Request parameter (Path format)
Item name Request parameter Type Value Default value
Profile ID profileId String   Impossible to omit
Response
{
　　　"entryPoint": "string",
　　　"fileName": "string",
　　　"jobExecMode": 0,
　　　"jobScript": "string",
　　　"receivingProfileId": "string",
　　　"receivingProfileName": "string"
}
Response parameter

For details of the response parameters, see Response parameter described in Acquire reception settings details.