Agents log

Resource: agentslog

Reads all specified fields from a given agents log record. All fields listed under parameter data are valid here and are passed as elements of an array in the parameter data.

Parameters:

  • data
    ARRAY. Each field is returned with the appropriate value of the record. Entries are sorted antichronologically. Following fields can be queried within the data parameter:
    Objekt_nr, Adress_nr, Aktionsart, Aktionstyp, Datum, created, Benutzer, Benutzer_nr, Datum_bearb, Kosten, Bemerkung, merkmal
  • estateid
    INTERGER. Return only entries associated with this estate record
  • adressid
    INTEGER. Return only entries associated with this address record
  • listlimit
    INTEGER. Maximum number of records returned in the response. Maximum: 500. Default: 20
  • fullmail
    BOOLEAN. If true, the associated email will be returned in the response parameter mailbody
  • tracking
    BOOLEAN. Return only entries released for object tracking
  • extendedclaim
    STRING. Mandatory for marketplace providers. Not relevant for all other users. To verify the user which uses the marketplace return the “apiClaim” parameter from the service call as “extendedclaim”. User rights are then observed by the marketplace provider API user.

Example:

...
{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
    "resourcetype": "agentslog",
    "resourceid": "",
    "identifier": "",
    "parameters": {
        "estateid": 2507,
        "data": [
            "Objekt_nr",
            "Aktionsart",
            "Aktionstyp",
            "Datum",
            "Bemerkung",
            "merkmal"
        ]
    }
}
...

Response:

  • (individually)
  • mailbody
    STRING. Mail body of the associated e-mail
  • {
        "status": {
            "code": 200,
            "errorcode": 0,
            "message": "OK"
        },
        "response": {
            "results": [
                {
                    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
                    "resourceid": "",
                    "resourcetype": "agentslog",
                    "cacheable": true,
                    "identifier": "",
                    "data": {
                        "meta": {
                            "cntabsolute": null
                        },
                        "records": [
                            {
                                "id": 15805,
                                "type": "agentslog",
                                "elements": {
                                    "Objekt_nr": [],
                                    "Aktionsart": "Freies Portal 40",
                                    "Aktionstyp": "insert",
                                    "Datum": "2019-06-24 11:06:22",
                                    "Bemerkung": "Freies Portal 40 eingestellt\n\nObjekt wurde mit folgender Anbieternummer \u00fcbertragen: 29065\nJobId: 74800366",
                                    "merkmal": null
                                }
                            },
                            {
                                "id": 15799,
                                "type": "agentslog",
                                "elements": {
                                    "Objekt_nr": [],
                                    "Aktionsart": "Freies Portal 30",
                                    "Aktionstyp": "insert",
                                    "Datum": "2019-06-24 11:06:20",
                                    "Bemerkung": "Freies Portal 30 eingestellt\n\nObjekt wurde mit folgender Anbieternummer \u00fcbertragen: 29065\nJobId: 74800360",
                                    "merkmal": null
                                }
                            },
                        ]
                    },
                    "status": {
                        "errorcode": 0,
                        "message": "OK"
                    }
                }
            ]
        }
    }