Skip to content
English
  • There are no suggestions because the search field is empty.

API AnnouncementsList

AnnouncementsList()

Returns a list of currently active announcements (announcements showing in the announcements panel)

Available since RPM33

Request

Request Data: no data required.

Response 

"Announcements": [
    {
        "ID": <int>,
        "NotificationType":  {
                "Color": <enum>, // See list below
                "Glyph": <enum>, // See list below
                "IsPriority": <boolean>, // Whether the announcement is a priority announcement
        },
        "EffectiveDate": <string>, // Date it became active 
        "ShortDescription": <string>,
        "Description": <string>, // May contain markdown 
         
    },
    // ... More active and planned notifications
]

Note: The response from the request to ProcFormAdd will contain the internal FormID for the new form. This is useful if you need to be able to edit the form afterwards.

The field on the new form:

ProcFormEdit

To edit a form, we use the ProcFormEdit API endpoint:

POST http://localhost/rpm/Api2.svc/ProcFormEdit HTTP/1.1
host: localhost
 
{
    "Key": "7c2c1037-b6fd-4b0a-b403-9ed39062ad76",
    "ProcessID": "2781",
    "Form": {
        "FormID": 221498,
        "Fields": [
            {
                "Field": "Yes/No List field",
                "Value": "{\"Values\":[{\"OptionID\":14321195,\"Value\":1,\"Comment\":\"Updated comment for this option\"},{\"OptionID\":14321196,\"Value\":1,\"Comment\":\"\"},{\"OptionID\":14321198,\"Value\":2,\"Comment\":\"\"}]}"
            }
        ]
    }
}

The field on the updated form:

Do Not Sell or Share My Personal Information