Customization Web API: getPublished

You can obtain the list of customization projects that are currently published in an MYOB Acumatica instance and the list of customization items in these projects.

HTTP Method and URL

To obtain the list of customization projects that are currently published in an MYOB Acumatica instance, you use the POST HTTP method and the following URL.

POST http(s)://<Acumatica ERP Instance URL>/CustomizationApi/getPublished

You replace <MYOB Acumatica instance URL> with the URL of your MYOB Acumatica instance.

Request Body

You do not need to pass any data in the request body.

Response Body

The following table lists the fields that the system returns in the body of the response.

Field Description
projects The names of the customization projects that are published in the system.
items The information about the customization items from all published projects, which contains the following fields:
  • key: The identifier of the customization item
  • screenId: The screen ID for generic inquiries and items that customize MYOB Acumatica forms
  • type: The type of the customization item
log
An array of log records. Each element of the array has the following fields:
  • timestamp: The date and time when the information about the performed operation was added to the log
  • logType: The type of the log message, which can be one of the following:
    • trace
    • information
    • warning
    • error
  • message: The log message

Example

The following request shows an example of the retrieval of the list of currently published customization projects.

Tip: In the request example below, <MYOB Acumatica instance URL> is the URL of the MYOB Acumatica instance (such as https://my.acumatica.com/MyInstance). You can omit the instance name in the URL (that is, you can use https://my.acumatica.com) if the instance is installed in the root of the website.
POST /<Acumatica ERP Instance URL>/CustomizationApi/getPublished HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json

If the response is 200 OK, it contains the body, which is shown in the following example.

{
    "projects": [
        {
            "name": "VisualWorkflow"
        },
        {
            "name": "PhoneRepairShop"
        }
    ],
    "items": [
        {
            "key": "~/pages/po/po302000.aspx",
            "screenId": "PO302000",
            "type": "Page"
        },
        {
            "key": "~/pages/rs/rs201000.aspx",
            "screenId": "RS201000",
            "type": "Page"
        },
        ...
    ],
    "log": []
}