31/03/2016

API деятельности в AutoCAD I/O API - Часть 1

Деятельность представляет собой действие, которое может быть запущено в основном ядре AutoCAD. Следующая деятельность доступна на веб-сайте AutoCAD I/O.

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

{
         "@odata.context":"https://developer-stg.api.autodesk.com/autocad.io/us-east/us-east/v2/$metadata#Activities/$entity","AppPackages":[
 
         ],"HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
         "InputParameters":[
         {
                 "Name":"HostDwg","LocalFileName":"$(HostDwg)","Optional":null
         }
         ],"OutputParameters":[
         {
                 "Name":"Result","LocalFileName":"result.pdf","Optional":null
         }
         ]
         },"Instruction":{
                 "CommandLineParameters":"-suppressGraphics","Script":"_tilemode 0 -export _pdf _all result.pdf\n"
         },"AllowedChildProcesses":[
 
         ],"IsPublic":false,"Version":1,"Timestamp":"2015-09-18T18:46:29.442Z","Description":"","Id":"PlotToPDF"
 }

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

"Id": Определяет уникальное имя. Этот параметр является обязательным.
"Instruction": Указывает действие.
"AppPackages": включает в себя ссылки на AppPackages. В случае, если ваша настраиваемая активность определяется в ARX (завернутая в AppPackage сущность), необходимо указать идентификатор AppPackage. Если ваша настраиваемая активность использует только собственные команды AutoCAD, то оставьте поле пустым.
"RequiredEngineVersion": Задает версию AutoCAD, который выполняет деятельность. При вводе в AutoCAD команда "ACADVER" возвращает это значение.
"Parameters": Определяет входные и выходные параметры. Они отображают имена реальных чертежей на имена чертежей, указанных в "Instruction".
"AllowedChildProcesses": Указывает дочерние процессы, которые будут порождены деятельностью. Любые порожденные дочерние процессы, не указанные здесь, будут отключены.
"version": содержит номер версии деятельности.
"Timestamp": Определяет время, когда последняя деятельность была создана или изменена. Вы можете пропустить его при создании деятельность.
"Description": Предоставляет более подробную информацию о деятельности. Это необязательный параметр.

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

Для создания деятельности

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

Создает деятельность. Если деятельность, имеющая такое же имя пользователя и идентификатор пользователя уже существует, возникает ошибка 302 - "An activity with the same Id is found. Please use Put or Patch to update.”

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

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

POST /autocad.io/us-east/v2/Activities HTTP/1.1
Content-Type: application/json
Authorization: Bearer my_token
 
{
  "HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
    "InputParameters":[
      {
        "Name":"HostDwg","LocalFileName":"$(HostDwg)"
      }
    ],"OutputParameters":[
      {
        "Name":"Result","LocalFileName":"result.dwg"
      }
    ]
  },"Instruction":{
    "CommandLineParameters":null,"Script":"_tilemode 1 _line 0,0 1,1  _save result.dwg\n"
  },"Version":1,"Id":"CreateALine"
}

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

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

HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Fri, 09 May 2014 23:14:49 GMT
Expires: -1
Location: https://developer.api.autodesk.com/autocad.io/us-east/v2/Activities('CreateALine')
Pragma: no-cache
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Content-Length: 579
Connection: keep-alive
 
{
    "@odata.context":"http://localhost:39284/api/v2/$metadata#Activities/$entity","AppPackages":[
 
    ],"HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
      "InputParameters":[
        {
          "Name":"HostDwg","LocalFileName":"$(HostDwg)"
        }
      ],"OutputParameters":[
        {
          "Name":"Result","LocalFileName":"result.dwg"
        }
      ]
    },"Instruction":{
      "CommandLineParameters":null,"Script":"_tilemode 1 _line 0,0 1,1  _save /result.dwg\n"
    },"AllowedChildProcesses":[
 
    ],"IsPublic":false,"Id":"CreateALine","Version":1,"Timestamp":"0001-01-01T00:00:00Z","Description":null
}

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

Код статуса HTTP	Сообщение разработчика
201	Деятельность успешно создана.
302	Найдена деятельность с таким же Id. Используйте Put или Patch для обновления.
401	Недостаточно правд для выполнения этой операции.
500	Внутренняя ошибка сервера

Заголовки запроса

Заголовок запроса	Описание
Тип содержимого	- Обязательный, application/x-www-form-urlencoded
Авторизация	- Обязательный, для предъявителя my_token

Для получения деятельности

GET autocad.io/us-east/v2/Activities('{my_id}')

Получить конкретную деятельность

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

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

GET /autocad.io/us-east/v2/Activities('PlotToPDF') HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer my_token
Host: autocad.io

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

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

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Mon, 12 May 2014 16:55:38 GMT
Expires: -1
Pragma: no-cache
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Content-Length: 563
Connection: keep-alive
 
 {
    "@odata.context":"https://developer.api.autodesk.com/autocad.io/us-east/v2/$metadata#Activities/$entity","AppPackages":[
    ],"HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
      "InputParameters":[
        {
          "Name":"HostDwg","LocalFileName":"$(HostDwg)"
        }
      ],"OutputParameters":[
        {
          "Name":"Result","LocalFileName":"result.pdf"
        }
      ]
    },"Instruction":{
      "CommandLineParameters":null,"Script":"_tilemode 0 -export _pdf _all result.pdf\n"
    },"AllowedChildProcesses":[
    ],"IsPublic":false,"Id":"PlotToPDF","Version":1,"Timestamp":"2015-05-19T23:30:04.034Z","Description":""
 }

Заголовки запроса

Заголовок запроса	Описание
Требуется, Авторизация	- Предъявитель my_token

Получить все деятельности

GET autocad.io/us-east/v2/Activities

Получить все деятельности

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

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

GET /autocad.io/us-east/v2/Activities HTTP/1.1
Accept: application/json
Accept-Charset: UTF-8
Authorization: Bearer my_token
Host: autocad.io

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

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

HTTP/1.1 200 OK
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Mon, 12 May 2014 16:55:38 GMT
Expires: -1
Pragma: no-cache
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Content-Length: 563
Connection: keep-alive
 
{
  "odata.context":"https://developer.api.autodesk.com/autocad.io/us-east/v2/$metadata#Activities","value":[
    {
      "AppPackages":[],"HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
      "InputParameters":[
        {
          "Name":"HostDwg","LocalFileName":"$(HostDwg)"
        }
      ],"OutputParameters":[
        {
          "Name":"Result","LocalFileName":"result.dwg"
        }
      ]
    },"Instruction":{
      "CommandLineParameters":null,"Script":"_tilemode 1 _line 0,0 1,1  _save result.dwg\n"
    },"AllowedChildProcesses":[
    ],"IsPublic":false,"Id":"CreateALine","Version":1,"Timestamp":"2015-05-19T23:30:04.034Z","Description":""
   },{
      "AppPackages":[],"HostApplication":"","RequiredEngineVersion":"20.1","Parameters":{
      "InputParameters":[
        {
          "Name":"HostDwg","LocalFileName":"$(HostDwg)"
        }
      ],"OutputParameters":[
        {
          "Name":"Result","LocalFileName":"result.pdf"
        }
      ]
    },"Instruction":{
      "CommandLineParameters":null,"Script":"_tilemode 0 -export _pdf _all result.pdf\n"
    },"AllowedChildProcesses":[
    ],"IsPublic":false,"Id":"PlotToPDF","Version":1,"Timestamp":"2015-05-19T23:30:04.034Z","Description":""
   }
  ]
}