Jump to

• Request
• Response

Create one local catalog

post

/fscmRestApi/resources/11.13.18.05/localCatalogs

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgreementDimension: string
  Title: Agreement Dimension

  Maximum Length: 20

  Default Value: INCLUDE_ALL

  Indicates whether all or specific agreements are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC, EXCLUDE_SOURCED. These values stand for include all agreements, include specific agreements, exclude specific agreements, and exclude all items sourced through agreements, respectively.
• agreements: array Agreements
  Title: Agreements

  Agreements that are specifically included in or excluded from the local catalog.
• CatalogDescription: string
  Title: Description

  Maximum Length: 240

  Description of the catalog.
• CatalogName(required): string
  Title: Catalog Name

  Maximum Length: 30

  Name of the local catalog.
• categories: array Categories
  Title: Categories

  Categories that are specifically included in or excluded from the local catalog.
• CategoryDimension: string
  Title: Category Dimension

  Maximum Length: 20

  Default Value: INCLUDE_ALL

  Indicates whether items from all or specific categories are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC. These values stand for include items from all categories, include items from specific categories, exclude items from specific categories, respectively.
• IncludeMasterItemsFlag: boolean
  Title: Include all master items

  Maximum Length: 1

  Default Value: false

  Indicates whether the catalog includes all master items. Contains one of the following values: true or false. If true, then the catalog includes master items. If false, then the catalog doesn't include master items. This attribute doesn't have a default value.
• ProcurementBU: string
  Title: Procurement BU

  Maximum Length: 240

  Procurement business unit in which the catalog is created.
• ProcurementBUId(required): integer (int64)
  Unique identifier of the procurement business unit in which the catalog is created.

{
    "required":[
        "CatalogName",
        "ProcurementBUId"
    ],
    "type":"object",
    "properties":{
        "AgreementDimension":{
            "title":"Agreement Dimension",
            "maxLength":20,
            "type":"string",
            "description":"Indicates whether all or specific agreements are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC, EXCLUDE_SOURCED. These values stand for include all agreements, include specific agreements, exclude specific agreements, and exclude all items sourced through agreements, respectively.",
            "nullable":false,
            "default":"INCLUDE_ALL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogName":{
            "title":"Catalog Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the local catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CategoryDimension":{
            "title":"Category Dimension",
            "maxLength":20,
            "type":"string",
            "description":"Indicates whether items from all or specific categories are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC. These values stand for include items from all categories, include items from specific categories, exclude items from specific categories, respectively.",
            "nullable":false,
            "default":"INCLUDE_ALL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "IncludeMasterItemsFlag":{
            "title":"Include all master items",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the catalog includes all master items. Contains one of the following values: true or false. If true, then the catalog includes master items. If false, then the catalog doesn't include master items. This attribute doesn't have a default value.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit in which the catalog is created.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of the procurement business unit in which the catalog is created.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "agreements":{
            "title":"Agreements",
            "type":"array",
            "description":"Agreements that are specifically included in or excluded from the local catalog.",
            "items":{
                "$ref":"#/components/schemas/localCatalogs-agreements-item-post-request"
            }
        },
        "categories":{
            "title":"Categories",
            "type":"array",
            "description":"Categories that are specifically included in or excluded from the local catalog.",
            "items":{
                "$ref":"#/components/schemas/localCatalogs-categories-item-post-request"
            }
        }
    }
}

Nested Schema : Agreements

Type: array

Title: Agreements

Agreements that are specifically included in or excluded from the local catalog.

Show Source

• Array of: object localCatalogs-agreements-item-post-request

{
    "title":"Agreements",
    "type":"array",
    "description":"Agreements that are specifically included in or excluded from the local catalog.",
    "items":{
        "$ref":"#/components/schemas/localCatalogs-agreements-item-post-request"
    }
}

Nested Schema : Categories

Type: array

Title: Categories

Categories that are specifically included in or excluded from the local catalog.

Show Source

• Array of: object localCatalogs-categories-item-post-request

{
    "title":"Categories",
    "type":"array",
    "description":"Categories that are specifically included in or excluded from the local catalog.",
    "items":{
        "$ref":"#/components/schemas/localCatalogs-categories-item-post-request"
    }
}

Nested Schema : localCatalogs-agreements-item-post-request

Type: object

Show Source

• AgreementHeaderId: integer (int64)
  Unique identifier of the agreement.

{
    "type":"object",
    "properties":{
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the agreement.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        }
    }
}

Nested Schema : localCatalogs-categories-item-post-request

Type: object

Show Source

• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 20

  Type of assignment for the local catalog. Valid values are PURCHASING_CATEGORY for a purchasing category assignment and BROWSING_CATEGORY for a browsing category assignment.
• CategoryId: integer (int64)
  Unique identifier of the category.
• CategoryName: string
  Title: Category

  Maximum Length: 255

  Name of the category.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":20,
            "type":"string",
            "description":"Type of assignment for the local catalog. Valid values are PURCHASING_CATEGORY for a purchasing category assignment and BROWSING_CATEGORY for a browsing category assignment.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":255,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgreementDimension: string
  Title: Agreement Dimension

  Maximum Length: 20

  Default Value: INCLUDE_ALL

  Indicates whether all or specific agreements are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC, EXCLUDE_SOURCED. These values stand for include all agreements, include specific agreements, exclude specific agreements, and exclude all items sourced through agreements, respectively.
• agreements: array Agreements
  Title: Agreements

  Agreements that are specifically included in or excluded from the local catalog.
• CatalogDescription: string
  Title: Description

  Maximum Length: 240

  Description of the catalog.
• CatalogId: integer (int64)
  Read Only: true

  Unique identifier of the catalog.
• CatalogName: string
  Title: Catalog Name

  Maximum Length: 30

  Name of the local catalog.
• CatalogType: string
  Title: Catalog Type

  Read Only: true

  Maximum Length: 80

  Type of the catalog.
• CatalogTypeCode: string
  Read Only: true

  Maximum Length: 15

  Default Value: LOCAL

  Code that identifies the catalog type. Value is always LOCAL.
• categories: array Categories
  Title: Categories

  Categories that are specifically included in or excluded from the local catalog.
• CategoryDimension: string
  Title: Category Dimension

  Maximum Length: 20

  Default Value: INCLUDE_ALL

  Indicates whether items from all or specific categories are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC. These values stand for include items from all categories, include items from specific categories, exclude items from specific categories, respectively.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the local catalog.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the local catalog was created.
• IncludeMasterItemsFlag: boolean
  Title: Include all master items

  Maximum Length: 1

  Default Value: false

  Indicates whether the catalog includes all master items. Contains one of the following values: true or false. If true, then the catalog includes master items. If false, then the catalog doesn't include master items. This attribute doesn't have a default value.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the local catalog was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the local catalog.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcurementBU: string
  Title: Procurement BU

  Maximum Length: 240

  Procurement business unit in which the catalog is created.
• ProcurementBUId: integer (int64)
  Unique identifier of the procurement business unit in which the catalog is created.

{
    "type":"object",
    "properties":{
        "AgreementDimension":{
            "title":"Agreement Dimension",
            "maxLength":20,
            "type":"string",
            "description":"Indicates whether all or specific agreements are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC, EXCLUDE_SOURCED. These values stand for include all agreements, include specific agreements, exclude specific agreements, and exclude all items sourced through agreements, respectively.",
            "nullable":false,
            "default":"INCLUDE_ALL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CatalogName":{
            "title":"Catalog Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the local catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CatalogType":{
            "title":"Catalog Type",
            "maxLength":80,
            "type":"string",
            "description":"Type of the catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogTypeCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the catalog type. Value is always LOCAL.",
            "nullable":false,
            "readOnly":true,
            "default":"LOCAL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryDimension":{
            "title":"Category Dimension",
            "maxLength":20,
            "type":"string",
            "description":"Indicates whether items from all or specific categories are included or excluded from the catalog. Valid values are INCLUDE_ALL, INCLUDE_SPECIFIC, EXCLUDE_SPECIFIC. These values stand for include items from all categories, include items from specific categories, exclude items from specific categories, respectively.",
            "nullable":false,
            "default":"INCLUDE_ALL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the local catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the local catalog was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "IncludeMasterItemsFlag":{
            "title":"Include all master items",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the catalog includes all master items. Contains one of the following values: true or false. If true, then the catalog includes master items. If false, then the catalog doesn't include master items. This attribute doesn't have a default value.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the local catalog was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the local catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit in which the catalog is created.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false,
                "dependencies":[
                    "OrganizationId"
                ]
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Unique identifier of the procurement business unit in which the catalog is created.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "agreements":{
            "title":"Agreements",
            "type":"array",
            "description":"Agreements that are specifically included in or excluded from the local catalog.",
            "items":{
                "$ref":"#/components/schemas/localCatalogs-agreements-item-response"
            }
        },
        "categories":{
            "title":"Categories",
            "type":"array",
            "description":"Categories that are specifically included in or excluded from the local catalog.",
            "items":{
                "$ref":"#/components/schemas/localCatalogs-categories-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Agreements

Type: array

Title: Agreements

Agreements that are specifically included in or excluded from the local catalog.

Show Source

• Array of: object localCatalogs-agreements-item-response

{
    "title":"Agreements",
    "type":"array",
    "description":"Agreements that are specifically included in or excluded from the local catalog.",
    "items":{
        "$ref":"#/components/schemas/localCatalogs-agreements-item-response"
    }
}

Nested Schema : Categories

Type: array

Title: Categories

Categories that are specifically included in or excluded from the local catalog.

Show Source

• Array of: object localCatalogs-categories-item-response

{
    "title":"Categories",
    "type":"array",
    "description":"Categories that are specifically included in or excluded from the local catalog.",
    "items":{
        "$ref":"#/components/schemas/localCatalogs-categories-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 : localCatalogs-agreements-item-response

Type: object

Show Source

• Agreement: string
  Title: Agreement

  Read Only: true

  Maximum Length: 20

  Number assigned to the agreement.
• AgreementHeaderId: integer (int64)
  Unique identifier of the agreement.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Maximum Length: 20

  Default Value: AGREEMENT

  Type of assignment for the local catalog. The valid value is AGREEMENT for an agreement assignment.
• CatalogAssignmentId: integer (int64)
  Read Only: true

  Unique identifier of the agreement assignment to the catalog.
• CatalogId: integer (int64)
  Read Only: true

  Unique identifier of the catalog.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who added the agreement to the catalog.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the agreement was added to the catalog.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Brief description about the agreement.
• IsAgreementAvailable: string
  Read Only: true

  Indicates whether the agreement is available for catalog assignment. Contains one of these values: true or false. If true, then the agreement is available. If false, then the agreement is no longer available. This attribute doesn't have a default value.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the agreement assignment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the agreement assignment.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 360

  Name of the supplier on the agreement.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site on the agreement.

{
    "type":"object",
    "properties":{
        "Agreement":{
            "title":"Agreement",
            "maxLength":20,
            "type":"string",
            "description":"Number assigned to the agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AgreementHeaderId":{
            "type":"integer",
            "description":"Unique identifier of the agreement.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":20,
            "type":"string",
            "description":"Type of assignment for the local catalog. The valid value is AGREEMENT for an agreement assignment.",
            "nullable":false,
            "readOnly":true,
            "default":"AGREEMENT",
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CatalogAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the agreement assignment to the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who added the agreement to the catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the agreement was added to the catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Brief description about the agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsAgreementAvailable":{
            "type":"string",
            "description":"Indicates whether the agreement is available for catalog assignment. Contains one of these values: true or false. If true, then the agreement is available. If false, then the agreement is no longer available. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "AgreementStatus",
                    "AgreementEndDate"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the agreement assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the agreement assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier on the agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site on the agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : localCatalogs-categories-item-response

Type: object

Show Source

• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 20

  Type of assignment for the local catalog. Valid values are PURCHASING_CATEGORY for a purchasing category assignment and BROWSING_CATEGORY for a browsing category assignment.
• CatalogAssignmentId: integer (int64)
  Read Only: true

  Unique identifier of the category assignment to the catalog.
• CatalogId: integer (int64)
  Read Only: true

  Unique identifier of the catalog.
• CategoryId: integer (int64)
  Unique identifier of the category.
• CategoryName: string
  Title: Category

  Maximum Length: 255

  Name of the category.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who added the category to the catalog.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the category was added to the catalog.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  Description of the category.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the category assignment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the category assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":20,
            "type":"string",
            "description":"Type of assignment for the local catalog. Valid values are PURCHASING_CATEGORY for a purchasing category assignment and BROWSING_CATEGORY for a browsing category assignment.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CatalogAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the category assignment to the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the catalog.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the category.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":255,
            "type":"string",
            "description":"Name of the category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who added the category to the catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the category was added to the catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the category assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the category assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

addAgreements

Operation: /fscmRestApi/resources/11.13.18.05/localCatalogs/{CatalogId}/action/addAgreements

Parameters:

• CatalogId: $request.path.CatalogId

Adds specific agreements to be included or excluded from a local catalog.

addCategories

Operation: /fscmRestApi/resources/11.13.18.05/localCatalogs/{CatalogId}/action/addCategories

Parameters:

• CatalogId: $request.path.CatalogId

Adds specific categories to be included or excluded from a local catalog.

agreements

Operation: /fscmRestApi/resources/11.13.18.05/localCatalogs/{CatalogId}/child/agreements

Parameters:

• CatalogId: $request.path.CatalogId

Agreements that are specifically included in or excluded from the local catalog.

categories

Operation: /fscmRestApi/resources/11.13.18.05/localCatalogs/{CatalogId}/child/categories

Parameters:

• CatalogId: $request.path.CatalogId

Categories that are specifically included in or excluded from the local catalog.

deleteAssignments

Operation: /fscmRestApi/resources/11.13.18.05/localCatalogs/{CatalogId}/action/deleteAssignments

Parameters:

• CatalogId: $request.path.CatalogId

Deletes the specific agreements or categories assigned to the catalog based on the value of the assignment type.

Back to Top