manual:api:reference:service:object

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:api:reference:service:object [2020/08/21 09:14]
martins-v internal link to data types (ZBX-17160)
manual:api:reference:service:object [2021/03/15 14:34]
marinagen [ZBX-18430] updated examples in ts_to and ts_from
Line 20: Line 20:
 The service time object defines periods, when an IT service is scheduled to be up or down. It has the following properties. The service time object defines periods, when an IT service is scheduled to be up or down. It has the following properties.
  
-^  Property ​ ^  Type  ^  Description ​ ^+^  Property ​ ^  ​[[:​manual/​api/​reference_commentary#​data_types|Type]]  ​^ ​ Description ​ ^
 | timeid ​ | string | //​(readonly)//​ ID of the service time. | | timeid ​ | string | //​(readonly)//​ ID of the service time. |
 | **serviceid** \\ (required) ​ | string | ID of the IT service. \\ \\ Cannot be updated. | | **serviceid** \\ (required) ​ | string | ID of the IT service. \\ \\ Cannot be updated. |
-| **ts_from** \\ (required) | integer | Time when the service time comes into effect. \\ \\ For onetime downtimes ''​ts_from''​ must be set as a Unix timestamp, for other types - as a specific time in a week, in seconds, for example, 90000 for Tue2:00 AM. | +| **ts_from** \\ (required) | integer | Time when the service time comes into effect. \\ \\ For onetime downtimes ''​ts_from''​ must be set as a Unix timestamp, for other types - as a specific time in a week, in seconds, for example, 90000 for Mon1:00 AM. | 
-| **ts_to** \\ (required) | integer | Time when the service time ends. \\ \\ For onetime uptimes ''​ts_to''​ must be set as a Unix timestamp, for other types - as a specific time in a week, in seconds, for example, 90000 for Tue2:00 AM. |+| **ts_to** \\ (required) | integer | Time when the service time ends. \\ \\ For onetime uptimes ''​ts_to''​ must be set as a Unix timestamp, for other types - as a specific time in a week, in seconds, for example, 90000 for Mon1:00 AM. |
 | **type** \\ (required) | integer | Service time type. \\ \\ Possible values: \\ 0 - planned uptime, repeated every week; \\ 1 - planned downtime, repeated every week; \\ 2 - one-time downtime. | | **type** \\ (required) | integer | Service time type. \\ \\ Possible values: \\ 0 - planned uptime, repeated every week; \\ 1 - planned downtime, repeated every week; \\ 2 - one-time downtime. |
 | note | string | Additional information about the service time. | | note | string | Additional information about the service time. |
Line 31: Line 31:
 The service dependency object represents a dependency between IT services. It has the following properties. The service dependency object represents a dependency between IT services. It has the following properties.
  
-^  Property ​ ^  Type  ^  Description ​ ^+^  Property ​ ^  ​[[:​manual/​api/​reference_commentary#​data_types|Type]]  ​^ ​ Description ​ ^
 | linkid | string | //​(readonly)//​ ID of the service dependency. | | linkid | string | //​(readonly)//​ ID of the service dependency. |
 | **servicedownid** \\ (required) | string ​ | ID of the IT service, that a service depends on, that is, the child service. An IT service can have multiple children. | | **servicedownid** \\ (required) | string ​ | ID of the IT service, that a service depends on, that is, the child service. An IT service can have multiple children. |
Line 43: Line 43:
 The service alarm objects represents an IT service'​s state change. It has the following properties. The service alarm objects represents an IT service'​s state change. It has the following properties.
  
-^  Property ​ ^  Type  ^  Description ​ ^+^  Property ​ ^  ​[[:​manual/​api/​reference_commentary#​data_types|Type]]  ​^ ​ Description ​ ^
 | servicealarmid | string | ID of the service alarm. | | servicealarmid | string | ID of the service alarm. |
 | serviceid | string | ID of the IT service. | | serviceid | string | ID of the IT service. |