Jump to

• Request
• Response

Get one calendar assignment

get

/fscmRestApi/resources/11.13.18.05/calendarAssignments/{AssignmentId}

Request

Path Parameters

• AssignmentId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

Type: object

Show Source

• AssignmentId: integer
  Title: ID

  Read Only: true

  Unique identifier for a row generated by sequence for the calendar assignment.
• AssociationType: integer
  Title: Association Type

  Read Only: true

  Code to identify the type of association. Valid values are Supplier, Customer, Organization, Carrier, Supplier Site, Customer Site, Carrier and Supplier, Carrier and Customer, Carrier and Organization, Carrier and Supplier Site, and Carrier and Customer Site.
• AssociationTypeName: string
  Title: Association

  Read Only: true

  Maximum Length: 4000

  Name for the association type.
• Calendar: string
  Title: Calendar

  Read Only: true

  Maximum Length: 240

  Name of the calendar to use for assignments.
• CalendarCode: string
  Title: ID

  Read Only: true

  Maximum Length: 22

  Unique identifier for the calendar in the source system.
• CalendarType: string
  Title: Calendar Type

  Read Only: true

  Maximum Length: 10

  Type of the calendar. Valid values are RECEIVING, SHIPPING, or CARRIER.
• CalendarTypeName: string
  Title: Calendar Type

  Read Only: true

  Maximum Length: 80

  Name of the calendar type.
• Carrier: string
  Title: Carrier

  Read Only: true

  Maximum Length: 4000

  Name of the carrier trading partner.
• Customer: string
  Title: Customer

  Read Only: true

  Maximum Length: 4000

  Name of the customer.
• CustomerSite: string
  Title: Customer Site

  Read Only: true

  Maximum Length: 4000

  Name of the customer site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Name of the organization.
• PartnerType: integer
  Title: Partner Type

  Read Only: true

  Code to designate the partner type. Valid values are Supplier, Customer, Organization, and Carrier.
• PartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 4000

  Name of the trading partner.
• PartySite: string
  Title: Party Site

  Read Only: true

  Maximum Length: 4000

  Location of the trading partner.
• PartyTypeName: string
  Title: Party Type

  Read Only: true

  Maximum Length: 4000

  Name of the type of trading partner. Valid values include Supplier, Customer, Organization, or Carrier.
• SourceSystem: string
  Title: Source System

  Read Only: true

  Maximum Length: 30

  Alphanumeric code used to identify the source system.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 4000

  Name of the supplier type trading partner.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 4000

  Location of the supplier.

{
    "type":"object",
    "properties":{
        "PartnerType":{
            "title":"Partner Type",
            "type":"integer",
            "description":"Code to designate the partner type. Valid values are Supplier, Customer, Organization, and Carrier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationTypeName":{
            "title":"Association",
            "maxLength":"4000",
            "type":"string",
            "description":"Name for the association type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Organization":{
            "title":"Organization",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "title":"Customer",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Calendar":{
            "title":"Calendar",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar to use for assignments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyTypeName":{
            "title":"Party Type",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the type of trading partner. Valid values include Supplier, Customer, Organization, or Carrier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartySite":{
            "title":"Party Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Location of the trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "title":"Customer Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarTypeName":{
            "title":"Calendar Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the calendar type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationType":{
            "title":"Association Type",
            "type":"integer",
            "description":"Code to identify the type of association. Valid values are Supplier, Customer, Organization, Carrier, Supplier Site, Customer Site, Carrier and Supplier, Carrier and Customer, Carrier and Organization, Carrier and Supplier Site, and Carrier and Customer Site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarCode":{
            "title":"ID",
            "maxLength":"22",
            "type":"string",
            "description":"Unique identifier for the calendar in the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"4000",
            "type":"string",
            "description":"Location of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"ID",
            "type":"integer",
            "description":"Unique identifier for a row generated by sequence for the calendar assignment.",
            "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"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the supplier type trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Carrier":{
            "title":"Carrier",
            "maxLength":"4000",
            "type":"string",
            "description":"Name of the carrier trading partner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceSystem":{
            "title":"Source System",
            "maxLength":"30",
            "type":"string",
            "description":"Alphanumeric code used to identify the source system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarType":{
            "title":"Calendar Type",
            "maxLength":"10",
            "type":"string",
            "description":"Type of the calendar. Valid values are RECEIVING, SHIPPING, or CARRIER.",
            "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