Woodwingstudio v1

This endpoint makes an HTTP POST request to {{Studio_Server_URL}}/{{Studio_Server_Directory}}/adminindex.php?protocol=JSON to perform a "LogOn" method. The request body should include the "AdminUser" and "Password" parameters for authentication, along with other optional parameters. The response will contain the result of the LogOn method execution.

Parameters

Create Object

Parameters

This endpoint is used to delete a specific file from the server directory. The request should include the file upload URL, current ticket, and the UUID for the PUT method in the query parameters. The response will indicate the success or failure of the deletion operation.

Request Body

This request does not require a request body.

Response Body

• success (boolean): Indicates whether the deletion operation was successful.

• message (string): Provides a message regarding the deletion operation.

Parameters

This endpoint allows you to upload a file to the specified directory on the Studio Server. The HTTP PUT request should be made to the provided URL with the ticket and fileguid as query parameters.

The response of this request is documented as a JSON schema.

Parameters

This endpoint allows you to send an HTTP POST request to the specified URL and directory with the purpose of logging on. The request payload should be in JSON format and include the method, id, and Params with specific user information. Upon successful execution, the response will be documented as a JSON schema.

Parameters

ConnectWebhooks Registration - GetTriggerOptions

This endpoint allows you to retrieve trigger options for ConnectWebhooks registration.

Request Body

• Method: JSON

• method: The method to be executed, set to "GetTriggerOptions".

• id: The ID of the request, set to "1".

• params: An array containing the request parameters, including the "Ticket" and "classname".

Response

The response will be in JSON format and follows the schema:

{
  "id": "",
  "result": {
    "Options": [
      {
        "Entity": {
          "Name": "",
          "DisplayName": "",
          "__classname__": ""
        },
        "EventTypes": [
          {
            "Name": "",
            "DisplayName": "",
            "__classname__": ""
          }
        ],
        "__classname__": ""
      }
    ],
    "__classname__": ""
  },
  "jsonrpc": ""
}

 ```

This JSON schema represents the structure of the response returned by the API endpoint.

Parameters

This HTTP POST request is used to create objects by sending a payload to the specified endpoint. The request is made to the {{Studio_Server_URL}}/{{Studio_Server_Directory}}/index.php?protocol=JSON URL with a JSON payload in the raw request body.

Request Body

• method (string): Specifies the method as "CreateObjects".

• id (string): Represents the ID as "33".

• params (array): Contains an array of parameters including "Ticket", "Lock", and "Objects".

• Ticket (string): Represents the ticket value, which is a placeholder.

• Lock (boolean): Indicates whether the object is locked or not.

• Objects (array): Contains an array of objects with metadata and files.

• MetaData (object): Contains various metadata properties such as BasicMetaData, WorkflowMetaData, RightsMetaData, SourceMetaData, ContentMetaData, and ExtraMetaData.

• Files (array): Contains an array of files with properties like Rendition, Type, and FileUrl.

• jsonrpc (string): Specifies the JSON-RPC version as "2.0".

Response

The response to this request will contain the result of the "CreateObjects" method call, along with any relevant data or error messages.

Parameters