02/04/2016

WorkItem в AutoCAD I/O API - часть 1

WorkItem представляет собой определенную задачу, которая выполняется основным движком AutoCAD. Ниже приведен пример WorkItem.

Код - HTML: [Выделить]

{
            "@odata.context":"https://developer-dev.api.autodesk.com/autocad.io/us-east/v2/$metadata#WorkItems/$entity","ActivityId":"PlotToPDF","Arguments":{
                  "InputArguments":[
                    {
                          "Resource":"https://s3.amazonaws.com/AutoCAD-Core-Engine-Services/TestDwg/makeall.dwg","Name":"HostDwg","Headers":[
 
                          ],"ResourceKind":null,"StorageProvider":"Generic","HttpVerb":null
                    }
                  ],"OutputArguments":[
                    {
                          "Resource":"https://acesdev.s3-us-west-2.amazonaws.com/aces-workitem-outputs/9688d314d6e94bc682f901b468ca8dbc/result.pdf?AWSAccessKeyId=
                          ASIAIIRAOVQYGB4OA7IA&Expires=1432231792&x-amz-security-token=AQoDYXdzEGIa0AMSDjA8SIKRwWVY8YvdmMQsZ3T5atGN2gDTUwcffe%2FMejuRGezSx%2F4lDaN1Nw
                          sGCc%2B91eXvocmWaEZA%2Bm8uClMwP%2Fr69UmL6RmOiK7dokQlbQGEoPEQwF%2Frpw2jPQ6wDq4suFWXlsuxODWP24v3GJ4fZRj9V4S91Z59Nagcla6Ll46YVS6rc0PlaC4ElJ89n
                          cABb23dR%2BK%2FAAaPsFVVn8ZV81gqDbect8YjvMH2RCfXQb7KnheNFlL77AXMeJM11ahq3UUsDk2o3uYQswJQJg5AsYZEtXjbbKU40MDkLPKjn5Ua18%2FD1pNZFm%2FFhoHMHXHv
                          fvJdfXPWHBKYEFCvIz%2FZyKg8CORDIpK04ZMuAV68jTiHGkes7U5L5QPnCDEDAyZnod6FK7djcNYQwJBE9SNge%2FBLAXmJ5Hsiuy8HZF7GF59LPSR%2BXyygw%2Fy1ssJxmKxK4js
                          UG33ukj69Mj1nXlKfVdk89cdonuOScw%2BnD91%2B1kRozlIXkDT9Crf%2FceshJHY48vaPtJ5VG1sGIZoHW5fzwcbXDEJzhLJcj0UaFr5N3sgMKCX7KtZcqRYp%2Bupd7khRSAhC2L
                          ZdOyCHAQgi45F11qYZ8fwiUassVPEYIwTpYiDbgfOqBQ%3D%3D&Signature=02E4g51C2R9NsdwX0vloUmX8RCM%3D","Name":"Result","Headers":[
                          ],"ResourceKind":null,"StorageProvider":"Generic","HttpVerb":"POST"
                    }
                  ]
            },"Status":"Succeeded","StatusDetails":{
                  "Report":"https://acesdev.s3-us-west-2.amazonaws.com/aces-workitem-reports/9688d314d6e94bc682f901b468ca8dbc/report.log?AWSAccessKeyId=ASIAIIRAOVQ
                  YGB4OA7IA&Expires=1432231871&x-amz-security-token=AQoDYXdzEGIa0AMSDjA8SIKRwWVY8YvdmMQsZ3T5atGN2gDTUwcffe%2FMejuRGezSx%2F4lDaN1NwsGCc%2B91eXvocmWa
                  EZA%2Bm8uClMwP%2Fr69UmL6RmOiK7dokQlbQGEoPEQwF%2Frpw2jPQ6wDq4suFWXlsuxODWP24v3GJ4fZRj9V4S91Z59Nagcla6Ll46YVS6rc0PlaC4ElJ89ncABb23dR%2BK%2FAAaPsFVV
                  n8ZV81gqDbect8YjvMH2RCfXQb7KnheNFlL77AXMeJM11ahq3UUsDk2o3uYQswJQJg5AsYZEtXjbbKU40MDkLPKjn5Ua18%2FD1pNZFm%2FFhoHMHXHvfvJdfXPWHBKYEFCvIz%2FZyKg8COR
                  DIpK04ZMuAV68jTiHGkes7U5L5QPnCDEDAyZnod6FK7djcNYQwJBE9SNge%2FBLAXmJ5Hsiuy8HZF7GF59LPSR%2BXyygw%2Fy1ssJxmKxK4jsUG33ukj69Mj1nXlKfVdk89cdonuOScw%2Bn
                  D91%2B1kRozlIXkDT9Crf%2FceshJHY48vaPtJ5VG1sGIZoHW5fzwcbXDEJzhLJcj0UaFr5N3sgMKCX7KtZcqRYp%2Bupd7khRSAhC2LZdOyCHAQgi45F11qYZ8fwiUassVPEYIwTpYiDbgfO
                  qBQ%3D%3D&Signature=omaAOII4CQaMUAXGChgsvT37I%2FU%3D"
            },"AvailabilityZone":null,"TimeQueued":"2015-05-20T18:09:47.957Z","TimeInputTransferStarted":"2015-05-20T18:09:48.035Z","TimeScriptStarted":"2015-05-20T18:09:48.707Z",
            "TimeScriptEnded":"2015-05-20T18:09:52.035Z","TimeOutputTransferEnded":"2015-05-20T18:09:52.16Z","BytesTranferredIn":169056,
            "BytesTranferredOut":53800,"Id":"9688d314d6e94bc682f901b468ca8dbc","Version":1,"Timestamp":"2015-05-20T18:09:52.16Z"
    }

Этот WorkItem выполняет WorkItem для экспорта входного чертежа в формат PDF. Он имеет следующие параметры:

"Id": Определяет уникальное имя. Оно назначается назначается AutoCAD I/O API. Вы можете определить его как пустую строку при создании WorkItem.
"Arguments": определяют ссылки на входной и выходной аргументы, необходимые в WorkItem. Это свойство является обязательным.
"Status": показывает результат выполненного задания. Вы можете пропустить его при создании WorkItem.
"StatusDetails": определяет ссылку на детали задачи, которая была выполнена. Пользователь может загрузить детали, используя упомянутую ссылку. Этот процесс может быть пропущен, при создании WorkItem.
"AvailabilityZone": определяет расположение сервера, на котором выполняется WorkItem. Этот параметр в настоящее время игнорируются.
"ActivityId": Ссылка на WorkItem, который будет выполнен. Это свойство является обязательным.
"Version": определяет номер версии WorkItem.
"Timestamp": Определяет время, когда последний WorkItem была создан или изменен. Вы можете пропустить его при создании WorkItem.

Пользователи имеют возможность создавать/читать/обновлять/удалять (CRUD - create/read/update/delete) WorkItem'ы.

Для создания WorkItem.

POST autocad.io/us-east/v2/WorkItems

Создаем WorkItem.

Пример успешного запроса:

Код - HTML: [Выделить]

POST https://developer.api.autodesk.com/autocad.io/us-east/v2/WorkItems HTTP/1.1
Content-Type: application/json
Authorization: Bearer my_token
Host: autocad.io
Content-Length: 1711
 
{
  "@odata.type":"#ACES.Models.WorkItem","Arguments":{
   "InputArguments":[
   {
      "Resource":"https://s3.amazonaws.com/AutoCAD-Core-Engine-Services/TestDwg/makeall.dwg?
      AWSAccessKeyId=AKIAIJFIKBQ63LIX6C2Q&Expires=1420099140&Signature=M08cnEcwClGjyNwwSll1GnaHhLw%3D",
      "Name":"HostDwg","StorageProvider":"Generic"
   }
   ],"OutputArguments":[
   {
     "Name":"Result","StorageProvider":"Generic","HttpVerb":"POST"
   }
   ]
   },"ActivityId":"PlotToPDF", "Id":""
}

Пример успешного ответа:

Код - HTML: [Выделить]

HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Tue, 13 May 2014 00:25:28 GMT
Expires: -1
Location: https://developer.api.autodesk.com/autocad.io/us-east/v2/WorkItems('9688d314d6e94bc682f901b468ca8dbc')
Pragma: no-cache
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Content-Length: 913
Connection: keep-alive
 
{
            "@odata.context":"https://developer-dev.api.autodesk.com/autocad.io/us-east/v2/$metadata#WorkItems/$entity","ActivityId":"PlotToPDF","Arguments":{
                  "InputArguments":[
                    {
                          "Resource":"https://s3.amazonaws.com/AutoCAD-Core-Engine-Services/TestDwg/makeall.dwg","Name":"HostDwg","Headers":[
 
                          ],"ResourceKind":null,"StorageProvider":"Generic","HttpVerb":null
                    }
                  ],"OutputArguments":[
                    {
                          "Resource":null,"Name":"Result","Headers":[
 
                          ],"ResourceKind":null,"StorageProvider":"Generic","HttpVerb":"POST"
                    }
                  ]
            },"Status":"Pending","StatusDetails":{
                  "Report":null
            },"AvailabilityZone":null,"TimeQueued":"2015-05-20T18:09:47.957112Z","TimeInputTransferStarted":null,"TimeScriptStarted":null,
            "TimeScriptEnded":null,"TimeOutputTransferEnded":null,"BytesTranferredIn":null,"BytesTranferredOut":null,
            "Id":"9688d314d6e94bc682f901b468ca8dbc","Version":1,"Timestamp":"0001-01-01T00:00:00Z"
  }

Коды статуса:

Коды статуса HTTP	Сообщение разработчика
201	WorkItem успешно создан.
401	Недостаточно прав для выполнения этой операции.
500	Внутренняя ошибка сервера