Jump to

• Request
• Response
• Examples

Get one pattern

get

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/calendarPatterns/{CalendarPatternId}

Request

Path Parameters

• CalendarPatternId(required): integer(int64)
  Value that uniquely identifies a calendar pattern. The application generates this value when it creates a calendar pattern. The calendar pattern ID and its attributes can't be updated after its creation.
• MaintenanceProgramId(required): integer(int64)
  Value that uniquely identifies a maintenance program. The application generates this value and is referenced during retrieval and update of a maintenance program definition. This value can't be updated after its creation.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : maintenancePrograms-calendarPatterns-item-response

Type: object

Show Source

• CalendarPatternId: integer (int64)
  Value that uniquely identifies a calendar pattern. The application generates this value when it creates a calendar pattern. The calendar pattern ID and its attributes can't be updated after its creation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MonthlySpecificDay: integer (int32)
  Value of the specific numerical day in a month when a monthly calendar pattern is due. This value can't be updated after its creation.
• MonthlyWeekday: string
  Maximum Length: 30

  Name of the specific day of the week when a monthly calendar pattern is due. The name is used with an ordinal value to define which day in the month the monthly calendar pattern is due. This value can't be updated after its creation.
• MonthlyWeekdayOrdinal: string
  Maximum Length: 30

  Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided. This value can't be updated after its creation.
• Name: string
  Title: Schedule Pattern

  Maximum Length: 120

  Name that uniquely identifies the calendar pattern in a maintenance program. This value can't be updated after its creation.
• RepeatDailyEveryWeekdayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the daily calendar pattern is due during days that are identified as weekdays. If false, then the daily calendar pattern is due all seven days of the week. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDayFridayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Friday. If false, then the weekly calendar pattern isn't due on Friday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDayMondayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Monday. If false, then the weekly calendar pattern isn't due on Monday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDaySaturdayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Saturday. If false, then the weekly calendar pattern isn't due on Saturday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDaySundayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Sunday. If false, then the weekly calendar pattern isn't due on Sunday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDayThursdayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Thursday. If false, then the weekly calendar pattern isn't due on Thursday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDayTuesdayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Tuesday. If false, then the weekly calendar pattern isn't due on Tuesday. The default value is false. This value can't be updated after its creation.
• RepeatWeeklyDayWednesdayFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Wednesday. If false, then the weekly calendar pattern isn't due on Wednesday. The default value is false. This value can't be updated after its creation.
• Type: string
  Title: Frequency

  Maximum Length: 30

  Value that specifies the frequency of a calendar pattern. Valid values include ORA_DAILY, ORA_WEEKLY, ORA_MONTHLY, or ORA_YEARLY. The default value is ORA_WEEKLY. This value can't be updated after its creation.
• YearlyMonth: string
  Maximum Length: 30

  Value of the month in which a numerical date is due for a yearly calendar pattern. You must define the numerical date and ordinal value. This value can't be updated after its creation.
• YearlySpecificDay: integer (int32)
  Value of the specific numerical date in a month for which a yearly calendar pattern is due. You must define the specific month. This value can't be updated after its creation.
• YearlySpecificMonth: string
  Maximum Length: 30

  Value of the specific month for which a yearly calendar pattern is due. You must define the specific numerical date in the month. This value can't be updated after its creation.
• YearlyWeekday: string
  Maximum Length: 30

  Name of the specific day of the week for which a yearly calendar pattern is due. The name is used with an ordinal value to define which day with a month the yearly calendar pattern is due. This value can't be updated after its creation.
• YearlyWeekdayOrdinal: string
  Maximum Length: 30

  Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided with the weekday name. This value can't be updated after its creation.

{
    "type":"object",
    "properties":{
        "RepeatDailyEveryWeekdayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the daily calendar pattern is due during days that are identified as weekdays. If false, then the daily calendar pattern is due all seven days of the week. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDaySundayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Sunday. If false, then the weekly calendar pattern isn't due on Sunday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthlyWeekdayOrdinal":{
            "maxLength":30,
            "type":"string",
            "description":"Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDayFridayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Friday. If false, then the weekly calendar pattern isn't due on Friday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDayTuesdayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Tuesday. If false, then the weekly calendar pattern isn't due on Tuesday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyMonth":{
            "maxLength":30,
            "type":"string",
            "description":"Value of the month in which a numerical date is due for a yearly calendar pattern. You must define the numerical date and ordinal value. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlySpecificMonth":{
            "maxLength":30,
            "type":"string",
            "description":"Value of the specific month for which a yearly calendar pattern is due. You must define the specific numerical date in the month. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "RepeatWeeklyDaySaturdayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Saturday. If false, then the weekly calendar pattern isn't due on Saturday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyWeekdayOrdinal":{
            "maxLength":30,
            "type":"string",
            "description":"Value that's used to define the specific ordinal day names, such as second Monday and last Monday. For each day of a week, the first, second, third, fourth, or last day of the month can be provided with the weekday name. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "MonthlyWeekday":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the specific day of the week when a monthly calendar pattern is due. The name is used with an ordinal value to define which day in the month the monthly calendar pattern is due. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlySpecificDay":{
            "type":"integer",
            "description":"Value of the specific numerical date in a month for which a yearly calendar pattern is due. You must define the specific month. This value can't be updated after its creation.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Schedule Pattern",
            "maxLength":120,
            "type":"string",
            "description":"Name that uniquely identifies the calendar pattern in a maintenance program. This value can't be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "RepeatWeeklyDayWednesdayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Wednesday. If false, then the weekly calendar pattern isn't due on Wednesday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the frequency of a calendar pattern. Valid values include ORA_DAILY, ORA_WEEKLY, ORA_MONTHLY, or ORA_YEARLY. The default value is ORA_WEEKLY. This value can't be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "RepeatWeeklyDayThursdayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Thursday. If false, then the weekly calendar pattern isn't due on Thursday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MonthlySpecificDay":{
            "type":"integer",
            "description":"Value of the specific numerical day in a month when a monthly calendar pattern is due. This value can't be updated after its creation.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "CalendarPatternId":{
            "type":"integer",
            "description":"Value that uniquely identifies a calendar pattern. The application generates this value when it creates a calendar pattern. The calendar pattern ID and its attributes can't be updated after its creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RepeatWeeklyDayMondayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the weekly calendar pattern is due on Monday. If false, then the weekly calendar pattern isn't due on Monday. The default value is false. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        },
        "YearlyWeekday":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the specific day of the week for which a yearly calendar pattern is due. The name is used with an ordinal value to define which day with a month the yearly calendar pattern is due. This value can't be updated after its creation.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to get one pattern.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenancePrograms/MaintenanceProgramId/child/calendarPatterns/CalendarPatternId"

For example, the following command gets one pattern:

curl -u username:password "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454/child/calendarPatterns/300100179946225"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"RepeatDailyEveryWeekdayFlag": true,
	"MonthlySpecificDay": null,
	"MonthlyWeekday": null,
	"MonthlyWeekdayOrdinal": null,
	"CalendarPatternId": 300100179946225,
	"Name": "Daily Pattern every weekday",
	"Type": "ORA_DAILY",
	"RepeatWeeklyDayFridayFlag": null,
	"RepeatWeeklyDayMondayFlag": null,
	"RepeatWeeklyDaySaturdayFlag": null,
	"RepeatWeeklyDaySundayFlag": null,
	"RepeatWeeklyDayThursdayFlag": null,
	"RepeatWeeklyDayTuesdayFlag": null,
	"RepeatWeeklyDayWednesdayFlag": null,
	"YearlyMonth": null,
	"YearlySpecificDay": null,
	"YearlySpecificMonth": null,
	"YearlyWeekday": null,
	"YearlyWeekdayOrdinal": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454/child/calendarPatterns/300100179946225",
		"name": "calendarPatterns",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454/child/calendarPatterns/300100179946225",
		"name": "calendarPatterns",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179925454",
		"name": "maintenancePrograms",
		"kind": "item"
	}
	]
}

Back to Top