REST API - Import Task Capture Payload

api/v1/taskcapture/payloads?artifactid={artifactid}\&processtypeid={processtypeid} description triggers an asynchronous job that in turn creates a digital blueprint under the selected artifact, with the actions sent in the payload the request will return the job id, that can be used to check the job status with get information of import task capture payload job request docid\ rxa4kcjuiv4xgvajnf5nl url structure \[blueprint uri]/api/v1/taskcapture/payloads?artifactid={artifactid}\&processtypeid={processtypeid} artifactid the id of the parent artifact where the payload will be imported processtypeid (optional) the artifact type of the imported process if this parameter is not specified, blueprint selects a random process artifact type in the project where the payload will be imported supported methods post docid\ hsi lzxs8g rx ydudzkg http status codes 200 ok – a job to import the payload is successfully triggered 400 bad request o the artifactid or processtypeid query parameter is not valid (less than 1) (errorcode=174) o the payload object in the request body is missing or invalid (missing required properties) (errorcode=175) 401 unauthorized – the blueprint authorization token is missing, invalid or expired (in the authorization request header) 404 not found the artifact specified by the artifactid request parameter is not found, deleted, or does not exist, or the user does not have the read permission on the specified artifact (errorcode=176) the artifact type specified by the processtypeid request parameters is not found in the project the specified parent artifact belongs to (errorcode=177) 403 forbidden – the user does not have the edit permission on the specified artifact (errorcode=125) 409 conflict the specified artifact type is found in the project the specified parent artifact belongs to, but the artifact type is not a process artifact type (errorcode=178) the project the specified parent artifact belongs to does not have any process artifact types this case can happen when the processtypeid request parameter is not specified (errorcode=179) the artifact is created by the user performing the request, but never published (errorcode=182) example json example request uri https //production blueprintcloud com/api/v1/taskcapture/payloads?artifactid=123\&processtypeid=10 request body contains the payload object { "version" 1, "name" "task capture payload 1", "description" "this is the first payload ", "activities" \[ { "useractiondescription" "user action 1", "systemresponsedescription" "system response 1", "image" "/9j/4aaqskzjrgabaqeayabgaad/2wbdaaggbgcgbqghbwcjcqgkdbqndasldbksew8uhrofhh0ahbwgjc4nicisixwckdcpldaxndq0hyc5ptgypc4zndl/2wbdaqkjcqwldbgndrgyirwhmjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjiymjl/waarcaaeaeodasiaahebaxeb/8qahwaaaqubaqebaqeaaaaaaaaaaaecawqfbgcicqol/8qatraaagedawieawufbaqaaaf9aqidaaqrbrihmuege1fhbyjxfdkbkaeii0kxwrvs0fakm2jyggkkfhcygroljicokso0nty3odk6q0rfrkdisuptvfvwv1hzwmnkzwznaglqc3r1dnd4exqdhiwgh4ijipktljwwl5izmqkjpkwmp6ipqrkztlw2t7i5usldxmxgx8jjytlt1nxw19jz2uhi4+tl5ufo6erx8vp09fb3+pn6/8qahweaawebaqebaqebaqaaaaaaaaecawqfbgcicqol/8qatreaagecbaqdbacfbaqaaqj3aaecaxeebsexbhjbuqdhcrmimoeifekrobhbcsmzuvavynlrchyknoel8rcygromjygpkju2nzg5okneruzhselku1rvvldywvpjzgvmz2hpann0dxz3ehl6gooehyahiimkkpoulzaxmjmaoqokpaanqkmqsro0tba3ulm6wspexcbhymnk0tpu1dbx2nna4upk5ebn6onq8vp09fb3+pn6/9oadambaairaxeapwd3vmn+1r/u487gx+8pqvtuu64/55rf9/d/ape0n/x9x/8axn/5rutaew64/wceux/fw/8axng64/55rf8afw//abns0uarbrj/aj5rf9/d/wde0brj/nlf/wb/d/8ae1lrqbfuup8anlf/38p/amtruup+eux/ah8p/watutfafvmn+1r/u487gx+8pqvtuu64/wceux/fw/8axndf8fcf/xn/5rutaetf8fcf/xn/5rutvwtoptuy8mpbrirshqts/zbf/nhf/wb8cgcwiovstv8a88iv++br9lt/+eex/faoaloql7lb/wdpcl/vgufzbf8a54rf98cgcwiovstv/wa8iv8avgufzbf/aj4rf98cgab/ai+4/wdrm/8analqq1tb9qjhkx4kmsng9vqx7lb/appcl/vguaf/2q==", "selector" "\[\r\n {\r\n \\"filename\\" \\"%programfiles%\\\\\\\microsoft office\\\\\\\root\\\\\\\office16\\\\\\\excel exe\\",\r\n", "appname" "excel", "action" "action 1", "actionparameters" \[ { "name" "parameter 1", "value" "some text" }, { "name" "parameter 2", "value" "987" } ], "timestamp" "2021 10 25t20 08 50 627209z" } ] } response body in the case of the returned 200 ok http status code, contains the id of the triggered job { "jobid" 123} in the case of the 400 bad request http status code, contains the error message { "message" "the payload object is missing ", "errorcode" 170}