Jump to

• Request
• Response

Get all calendars

get

/fscmRestApi/resources/11.13.18.05/calendars

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a calendar that matches the primary key.
    Finder Variables
    • CalendarCode; string; Code for the calendar primary key finder.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Calendar; string; Name of the workday calendar.
  • CalendarCode; string; Unique identifier for the calendar in the source system.
  • CalendarCodeName; string; Name of the unique identifier for the calendar in the source system.
  • CalendarDaysOff; integer; Number of consecutive nonworking days.
  • CalendarDaysOn; integer; Number of consecutive working days.
  • Description; string; Description of the calendar.
  • EndDate; string; End date for the calendar.
  • ExceptionEndDate; string; Last date till which any exception in the calendar is valid. The last date must be within the calendar start date and end date, both inclusive.
  • ExceptionStartDate; string; Start date from which any exception in the calendar is valid. The start date must be within the calendar start date and end date, both inclusive.
  • ExceptionType; integer; Code for the exception type. Valid values are 1 for On and 2 for Off.
  • ExceptionTypeName; string; Status of the exception type. Valid values are Available and Not Available.
  • QuarterlyCalTypeName; string; Name of the quarterly calendar type.
  • QuarterlyCalendarType; integer; Quarterly calendar type code. Valid values are 1 for 445 week pattern, 2 for 544 week pattern, 3 for 13 periods for the calendar year, 4 for regular months of the calendar year, and 5 for 454 week pattern.
  • Sequence; integer; Sequence number for working days in the calendar.
  • SourceSystem; string; Alphanumeric code used to identify the source system.
  • StartDate; string; Beginning date for the calendar.
  • WeekStartDay; integer; The day from which the calendar pattern string begins. Valid values are 1 for pattern string starts on a Monday, 2 for pattern string starts on the same day of the week on which the calendar start date falls.
  • WeekStartDayName; string; Name of the week start day.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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:
  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.

Body ()

Root Schema : calendars

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/calendars-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object calendars-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/calendars-item-response"
    }
}

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 : calendars-item-response

Type: object

Show Source

• Calendar: string
  Title: Calendar

  Read Only: true

  Maximum Length: 255

  Name of the workday calendar.
• CalendarCode: string
  Title: ID

  Read Only: true

  Maximum Length: 32

  Unique identifier for the calendar in the source system.
• CalendarCodeName: string
  Title: Calendar Code

  Read Only: true

  Maximum Length: 32

  Name of the unique identifier for the calendar in the source system.
• CalendarDaysOff: integer
  Title: Days Off

  Read Only: true

  Number of consecutive nonworking days.
• CalendarDaysOn: integer
  Title: Days On

  Read Only: true

  Number of consecutive working days.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 250

  Description of the calendar.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  End date for the calendar.
• ExceptionEndDate: string (date)
  Title: Exception End Date

  Read Only: true

  Last date till which any exception in the calendar is valid. The last date must be within the calendar start date and end date, both inclusive.
• ExceptionStartDate: string (date)
  Title: Exception Start Date

  Read Only: true

  Start date from which any exception in the calendar is valid. The start date must be within the calendar start date and end date, both inclusive.
• ExceptionType: integer
  Title: Exception Type Code

  Read Only: true

  Code for the exception type. Valid values are 1 for On and 2 for Off.
• ExceptionTypeName: string
  Title: Exception Type

  Read Only: true

  Maximum Length: 250

  Status of the exception type. Valid values are Available and Not Available.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuarterlyCalendarType: integer
  Title: Quarterly Type Code

  Read Only: true

  Quarterly calendar type code. Valid values are 1 for 445 week pattern, 2 for 544 week pattern, 3 for 13 periods for the calendar year, 4 for regular months of the calendar year, and 5 for 454 week pattern.
• QuarterlyCalTypeName: string
  Title: Quarterly Type

  Read Only: true

  Maximum Length: 4000

  Name of the quarterly calendar type.
• Sequence: integer
  Title: Sequence

  Read Only: true

  Sequence number for working days in the calendar.
• SourceSystem: string
  Title: Source System

  Read Only: true

  Maximum Length: 30

  Alphanumeric code used to identify the source system.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Beginning date for the calendar.
• WeekStartDay: integer
  Title: Weekly Start Day Code

  Read Only: true

  The day from which the calendar pattern string begins. Valid values are 1 for pattern string starts on a Monday, 2 for pattern string starts on the same day of the week on which the calendar start date falls.
• WeekStartDayName: string
  Title: Week Start Day

  Read Only: true

  Maximum Length: 250

  Name of the week start day.

{
    "type":"object",
    "properties":{
        "ExceptionType":{
            "title":"Exception Type Code",
            "type":"integer",
            "description":"Code for the exception type. Valid values are 1 for On and 2 for Off.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"250",
            "type":"string",
            "description":"Description of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuarterlyCalTypeName":{
            "title":"Quarterly Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the quarterly calendar type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Calendar":{
            "title":"Calendar",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the workday calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionStartDate":{
            "title":"Exception Start Date",
            "type":"string",
            "description":"Start date from which any exception in the calendar is valid. The start date must be within the calendar start date and end date, both inclusive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeekStartDay":{
            "title":"Weekly Start Day Code",
            "type":"integer",
            "description":"The day from which the calendar pattern string begins. Valid values are 1 for pattern string starts on a Monday, 2 for pattern string starts on the same day of the week on which the calendar start date falls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeekStartDayName":{
            "title":"Week Start Day",
            "maxLength":"250",
            "type":"string",
            "description":"Name of the week start day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number for working days in the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date for the calendar.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarDaysOn":{
            "title":"Days On",
            "type":"integer",
            "description":"Number of consecutive working days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarCodeName":{
            "title":"Calendar Code",
            "maxLength":"32",
            "type":"string",
            "description":"Name of the unique identifier for the calendar in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Beginning date for the calendar.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionEndDate":{
            "title":"Exception End Date",
            "type":"string",
            "description":"Last date till which any exception in the calendar is valid. The last date must be within the calendar start date and end date, both inclusive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarDaysOff":{
            "title":"Days Off",
            "type":"integer",
            "description":"Number of consecutive nonworking days.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuarterlyCalendarType":{
            "title":"Quarterly Type Code",
            "type":"integer",
            "description":"Quarterly calendar type code. Valid values are 1 for 445 week pattern, 2 for 544 week pattern, 3 for 13 periods for the calendar year, 4 for regular months of the calendar year, and 5 for 454 week pattern.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"ID",
            "maxLength":"32",
            "type":"string",
            "description":"Unique identifier for the calendar in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"Alphanumeric code used to identify the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExceptionTypeName":{
            "title":"Exception Type",
            "maxLength":"250",
            "type":"string",
            "description":"Status of the exception type. Valid values are Available and Not Available.",
            "nullable":true,
            "readOnly":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