SiteScheduledJobs.getProperties (Method)
Retrieves information about the specified scheduled job's properties.
Returns:
ScheduledJobs_GetProperties_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Component | PlainText_NonNull_100 | The component that will be called. |
| DisplayName | PlainText_NonNull_100 | The user given name of the scheduled job instance. |
| JobDefinitionID | PositiveInteger | The ID of the job definition from which this job was created. |
| JobDefinitionName | PlainText_NonNull_100 | The name of job definition. |
| Method | PlainText_NonNull_100 | The method that will be called. |
| Properties | PropertyField_Struct_Array | An array of structures describing the field properties for the scheduled job. |
| ServerID | ServerID_Spec | The ID of the server on which the job runs. 0 for all servers, -1 for authoring server, -2 for all ROPS, -3 for all cache servers. |
| ServerName | PlainText_NonNull_100 | The name of the server on which the job runs, or 'All'. |
| SourceScope | PrimaryScope | The source scope of the available job from which this job was created. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| scheduledJobID | SiteScheduledJobID | Required | The unique ID of the scheduled job. |
Context:
| License Requirements | (none) |
| Permission Requirements | hybrid:JobOwnerOrSiteAdmin |
| Deny Context | ClusterROPS |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None