Jump to

• Request
• Response

Get all agreement item attributes

get

/fscmRestApi/resources/11.13.18.05/purchaseAgreementLines/{AgreementLineId}/child/itemAttributes

Request

Path Parameters

• AgreementLineId(required): integer(int64)
  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
• 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 agreement line item attributes according to their primary key.
    Finder Variables
    • AttributeValuesId; integer; Value that uniquely identifies the agreement line item attribute.
• 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:
  

  • AttributeValuesId; integer; Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
  • AttributeValuesTlpId; integer; Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
  • Manufacturer; string; Name of the manufacturer of the item specified on a blanket purchase agreement line.
  • ManufacturerPartNumber; string; Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.
  • UNSPSC; string; The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
• 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 : purchaseAgreementLines-itemAttributes

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/purchaseAgreementLines-itemAttributes-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseAgreementLines-itemAttributes-item-response

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

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 : purchaseAgreementLines-itemAttributes-item-response

Type: object

Show Source

• Alias: string
  Title: Alias

  Read Only: true

  Maximum Length: 700

  Alternate identifier for an item specified on a blanket purchase agreement line.
• AttachmentURL: string
  Title: Attachment URL

  Read Only: true

  Maximum Length: 700

  URL of the attachment associated with the item.
• AttributeValuesId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
• AttributeValuesTlpId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
• Availability: string
  Title: Availability

  Read Only: true

  Maximum Length: 700

  Status of the item availability from supplier.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the item attributes for a purchase agreement line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application created the item attributes for a purchase agreement line.
• ImageURL: string
  Title: Image URL

  Read Only: true

  Maximum Length: 700

  URL of the image file associated with the item specified on a blanket purchase agreement line.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application last updated the item attributes on a purchase agreement line.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the item attributes on a purchase agreement line.
• LeadTimeDays: number
  Title: Lead Time Days

  Read Only: true

  The number of days in which the item, specified on the blanket purchase order line, can be delivered when ordered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  Text describing the long description of the item specified on a blanket purchase agreement line.
• Manufacturer: string
  Title: Manufacturer

  Read Only: true

  Maximum Length: 700

  Name of the manufacturer of the item specified on a blanket purchase agreement line.
• ManufacturerPartNumber: string
  Title: Manufacturer Part Number

  Read Only: true

  Maximum Length: 700

  Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.
• ManufacturerURL: string
  Title: Manufacturer URL

  Read Only: true

  Maximum Length: 700

  URL of the manufacturer of the item specified on a blanket purchase agreement line.
• PackagingString: string
  Title: Packaging String

  Read Only: true

  Maximum Length: 240

  String that describes how the item is packed by the supplier.
• RoundingFactor: number
  Title: Rounding Factor

  Read Only: true

  Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
• SupplierURL: string
  Title: Supplier URL

  Read Only: true

  Maximum Length: 700

  URL of the supplier's organization.
• ThumbnailImageURL: string
  Title: Thumbnail Image

  Read Only: true

  Maximum Length: 700

  Location of the small version of a larger image file for the item specified on the blanket purchase agreement.
• UNSPSC: string
  Title: UNSPSC

  Read Only: true

  Maximum Length: 700

  The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.

{
    "type":"object",
    "properties":{
        "Availability":{
            "title":"Availability",
            "maxLength":"700",
            "type":"string",
            "description":"Status of the item availability from supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the item attributes on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the item attributes for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AttachmentURL":{
            "title":"Attachment URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the attachment associated with the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerURL":{
            "title":"Manufacturer URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the item attributes for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LeadTimeDays":{
            "title":"Lead Time Days",
            "type":"number",
            "description":"The number of days in which the item, specified on the blanket purchase order line, can be delivered when ordered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "maxLength":"700",
            "type":"string",
            "description":"Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the image file associated with the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RoundingFactor":{
            "title":"Rounding Factor",
            "type":"number",
            "description":"Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"3",
                "scale":"3"
            }
        },
        "AttributeValuesTlpId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Text describing the long description of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Alias":{
            "title":"Alias",
            "maxLength":"700",
            "type":"string",
            "description":"Alternate identifier for an item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ThumbnailImageURL":{
            "title":"Thumbnail Image",
            "maxLength":"700",
            "type":"string",
            "description":"Location of the small version of a larger image file for the item specified on the blanket purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "maxLength":"700",
            "type":"string",
            "description":"Name of the manufacturer of the item specified on a blanket purchase agreement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UNSPSC":{
            "title":"UNSPSC",
            "maxLength":"700",
            "type":"string",
            "description":"The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.",
            "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"
            }
        },
        "AttributeValuesId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PackagingString":{
            "title":"Packaging String",
            "maxLength":"240",
            "type":"string",
            "description":"String that describes how the item is packed by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierURL":{
            "title":"Supplier URL",
            "maxLength":"700",
            "type":"string",
            "description":"URL of the supplier's organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the buyer or application last updated the item attributes on a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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