Resource URl

url_to_cmo_application_instance/api/events/

where url_to_cmo_application_instance is url to cmo web site.

Resource Information

Request Model (Payload)

GpsCoordinates Type Structure:

NotificationSettings Type Structure

PartyInvolved Type Structure

 
CategoryTypeSeverity

CustomField Type Structure

Custom Field Value Format  

RiskAssessment Type Structure:

Gps Type Structure:

Usage Notes:

• Some of response model properties have name and ID. Only one of this property should be specified. ID has highest priority. It's mean that If both properties are specified, then object will be selected by ID, name will be ignored.
• To search object by name the system use strict string equals (case sensetive). If more that one object was found, then the system will be unable to proceed (create an event).
• The system validates model according to configuration. Typically, the system will provide full list of validation errors. Some of validation rules are depend from Company or Template. So, if the system is unable to parse Company or Template then the system will unable to provide correct validation errors which are based on these objects.
• Attempt to set value of property which is disabled based on BR will cause validation error.
• All collections should not contains duplicates.
• User must have access to all objects based on user permissions, especially to Org Unit / Entity Pair.

Example Request:

curl -X POST \
  https://cmo/api/events/ \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWJqZWN0IjoyLCJleHAiOjE2NzEyNTI2MTUuMH0.cFq-wdxS5bLN-7WXuzCc35MUFKW465YkiyAvwcu1plo' \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -H 'company: 2' \
  -d '{
    "companyID": 2,
    "companyName": "cmo company",
    "orgUnitID": 2,
    "orgUnitName": "cmo org unit",
    "entityID": "26DD4858-4F08-49C7-9EE2-BC93B3BAC436",
    "entityName": "cmo entity",
    "entityTypeID": 2,
    "entityTypeName": "cmo entity type",
    "templateID": 2,
    "templateName": "cmo template / form",
    "eventStartDate": "2019-02-26T08:41:52.2086077Z",
    "eventDate": "2019-02-27T08:41:52.2086077Z",
    "dueDate": "2019-02-28T08:41:52.2086077Z",
    "reporterUserID": 2,
    "reporterLogin": "cmo.user",
    "reporterName": "cmo user",
    "eventTitle": "event title",
    "gpsCoordinates": {
        "x": 1,
        "y": 1,
        "z": 0
    },
    "firstReminder": 2,
    "secondReminder": 7,
    "syncStatus": 1,
    "baseScore": 2,
    "targetScore": 2,
    "statusID": 2,
    "statusName": "cmo status",
    "subStatusID": 2,
    "subStatusName": "cmo sub status",
    "notificationSettings": {
        "notifyNow": true,
        "notifyUponCompletion": true,
        "nonDefaultUserIDsForNowAndCompletedEmails": [
            2
        ],
        "nonDefaultUserNamesForNowAndCompletedEmails": [
            "cmo user"
        ]
    },
    "categoryTypeSeverities": [
        {
            "categoryID": 2,
            "typeID": 2,
            "severityID": "C39FBB68-7028-49D3-B313-DE4DF77514E8"
        },
        {
            "categoryName": "cmo category",
            "typeName": "cmo type",
            "severityName": "cmo severity"
        }
    ],
    "executiveSummary": "executive summary value",
    "recommendations": "recommendations value",
    "partiesInvolved": [
        {
            "userName": "cmo user",
            "involvementTypeID": 2
        },
        {
            "userID": 2,
            "involvementTypeName": "cmo involvement type"
        }
    ],
    "classificationIDs": [
        "E7A3951E-6766-4D3F-99F0-1D1D053A5B18"
    ],
    "classificationNames": [
        "cmo classification"
    ],
    "confidential": true,
    "customFields": [
        {
            "customFieldID": 1,
            "value": "orange"
        },
        {
            "customFieldName": "cmo custom field",
            "value": "txt value"
        },
        {
            "customFieldID": "2",
            "value": "ajax drop down new value"
        },
        {
            "customFieldID": "3",
            "value": "[\"red\",\"green\"]"
        },
        {
            "customFieldID": "4",
            "value": "[\"2\"]"
        },
        {
            "customFieldID": "5",
            "value": "[\"1\",\"3\"]"
        },
        {
            "customFieldID": "6",
            "value": "2019-03-01T06:02:03.1676434Z"
        },
        {
            "customFieldID": "7",
            "value": "{\"consequenceCode\": 1,\"likelihoodCode\": 1}"
        },
        {
            "customFieldID": "8",
            "value": "{\"latitude\": 1,\"longitude\": 1}"
        }
    ]
}'

Example Response:

"a4afd011-3e52-4525-8b68-3d465a8c0882"

{
    "message": "Model can't be processed due to following errors",
    "errors": [
        {
            "field": "OrgUnitID",
            "messages": [
                "System is unable to find object based on the provided id(s). (Values: 171)"
            ]
        },
        {
            "field": "EntityTypeName",
            "messages": [
                "System is unable to find object based on the provided name(s). (Values: DW_Entity_Type_1a)"
            ]
        },
        {
            "field": "EndDate",
            "messages": [
                "Mandatory but was not specified."
            ]
        }
    ]
}

Authentication

• User send POST request with login and password to token controller (controller location is: https://cmo_server_url/api/token).
• If system is able to authenticate a user based on provided login and password then the system will return special token.
• To send request to event api an user need to include the token (mentioned in previous point) into the request, ie add 'Authorization' header with token, for instance (for cURL) it looks like: -H 'Authorization: Bearer token_is_here'. The system will check that token is valid on every request. If token is valid, then system will assume that request is performed by an user which login and password were provided in the first point.
• Note there are two ways to call event api for dependent (I mean not main company in the same cmo instance) company:
  • Authenticate as fake user which system silently creates for every company (I think it's not convinient way)
  • Specify company identifier in the request header (I think it's more convinient way), for instane for cURL it looks like: -H 'company: 42', where 42 is an identifier of a dependent company.