Woodwingstudioconnector v1.0

/{Studio_Server_Directory}/adminindex.php

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

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the administration endpoint is located.
`Protocol`	The protocol to use for the administration request (e.g., 'http' or 'https').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Method`	The administration method to invoke.
`Id`	An identifier associated with the administration method call.
`Jsonrpc`	The JSON-RPC version to use for the request (e.g., '2.0').

/{Studio_Server_Directory}/{entryPoint}

Create Object

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the object creation endpoint is located.
`Entrypoint`	The entry point within the Studio Server for creating the object.
`Protocol`	The protocol to use for the request (e.g., 'http' or 'https').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	An identifier for the object creation request.
`Jsonrpc`	The JSON-RPC version to use for the request (e.g., '2.0').
`Method`	The method to invoke for creating the object.

/{Studio_Server_Directory}/transferindex.php

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

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the transfer index endpoint is located.
`Ticket`	The ticket identifier for the transfer request to delete.
`Fileguid`	The file GUID associated with the transfer request.
`Httpmethod`	The HTTP method that was used for the original transfer request.
`Format`	The format of the response (e.g., 'json' or 'xml').
`Response Type`	The response format expected from the API (e.g. application/json).

/{Studio_Server_Directory}/transferindex.php

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

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the transfer index endpoint is located.
`Ticket`	The ticket identifier for the upload request.
`Fileguid`	The file GUID to associate with the uploaded object.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file to upload to the transfer server.

/{Studio_Server_Directory}/editorialplan.php

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

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the planning endpoint is located.
`Protocol`	The protocol to use for the planning request (e.g., 'http' or 'https').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Method`	The planning method to invoke.
`Id`	An identifier associated with the planning method call.
`Jsonrpc`	The JSON-RPC version to use for the request (e.g., '2.0').

/{Studio_Server_Directory}/pluginindex.php

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:

JavaScript

{
  "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

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the webhook endpoint is located.
`Plugin`	The plugin identifier for the webhook.
`Interface`	The interface name for the webhook.
`Protocol`	The protocol to use for the webhook request (e.g., 'http' or 'https').
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Method`	The webhook method to invoke.
`Id`	An identifier associated with the webhook method call.
`Jsonrpc`	The JSON-RPC version to use for the request (e.g., '2.0').

/{Studio_Server_Directory}/index.php

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

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`queryParams`	Additional query string name/value pairs to append to the request URL.
`Studio Server Directory`	The directory path on the Studio Server where the workflow endpoint is located.
`Protocol`	The protocol to use for the workflow request (e.g., 'http' or 'https').
`User`	The username for authentication with the workflow endpoint.
`Password`	The password for authentication with the workflow endpoint.
`Clientname`	The client name identifier for the workflow request.
`Clientappname`	The client application name for the workflow request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Method`	The workflow method to invoke.
`Id`	An identifier associated with the workflow method call.
`Jsonrpc`	The JSON-RPC version to use for the request (e.g., '2.0').

Administration

General

Digital Object (2)

Request Body

Response Body

Planning

Webhooks

ConnectWebhooks Registration - GetTriggerOptions

Request Body

Response

Workflow

Request Body

Response