Jump to

• Request
• Response

Update one informational catalog

patch

/fscmRestApi/resources/11.13.18.05/informationalCatalogs/{CatalogId}

Update one informational catalog

Request

Path Parameters

• CatalogId(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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CatalogDescription: string
  Title: Description

  Maximum Length: 240

  Description of the informational catalog.
• CatalogName: string
  Title: Catalog Name

  Maximum Length: 30

  Name of the informational catalog.
• categoryAssignments: array Category Assignments
  Title: Category Assignments

  Details of the categories assigned to the informational catalog for browsing.
• ContentURL: string
  Title: URL

  Maximum Length: 240

  URL of the content for the informational catalog.
• ImageURL: string
  Title: Image URL

  Maximum Length: 240

  URL of the image for the informational catalog.
• Keywords: string
  Title: Keywords

  Maximum Length: 4000

  Keywords used to search for and identify the informational catalog.

{
    "type":"object",
    "properties":{
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the informational catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogName":{
            "title":"Catalog Name",
            "maxLength":30,
            "type":"string",
            "description":"Name of the informational catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "ContentURL":{
            "title":"URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the content for the informational catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the image for the informational catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":4000,
            "type":"string",
            "description":"Keywords used to search for and identify the informational catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Details of the categories assigned to the informational catalog for browsing.",
            "items":{
                "$ref":"#/components/schemas/informationalCatalogs-categoryAssignments-item-patch-request"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.

Show Source

• Array of: object informationalCatalogs-categoryAssignments-item-patch-request

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Details of the categories assigned to the informational catalog for browsing.",
    "items":{
        "$ref":"#/components/schemas/informationalCatalogs-categoryAssignments-item-patch-request"
    }
}

Nested Schema : informationalCatalogs-categoryAssignments-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• CatalogDescription: string
  Title: Description

  Maximum Length: 240

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

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

  Maximum Length: 30

  Name of the informational 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: INFORMATIONAL

  Code that identifies the catalog type. Value is always INFO.
• categoryAssignments: array Category Assignments
  Title: Category Assignments

  Details of the categories assigned to the informational catalog for browsing.
• ContentURL: string
  Title: URL

  Maximum Length: 240

  URL of the content for the informational catalog.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the informational catalog was created.
• ImageURL: string
  Title: Image URL

  Maximum Length: 240

  URL of the image for the informational catalog.
• Keywords: string
  Title: Keywords

  Maximum Length: 4000

  Keywords used to search for and identify the informational catalog.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the informational catalog.
• LastUpdatedDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the informational catalog was last updated.
• 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":{
        "CatalogDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the informational catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CatalogId":{
            "type":"integer",
            "description":"Unique identifier of the informational 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 informational 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 INFO.",
            "nullable":false,
            "readOnly":true,
            "default":"INFORMATIONAL",
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContentURL":{
            "title":"URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the content for the informational catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the informational catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the informational catalog was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ImageURL":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL of the image for the informational catalog.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Keywords":{
            "title":"Keywords",
            "maxLength":4000,
            "type":"string",
            "description":"Keywords used to search for and identify the informational catalog.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "KeywordsClob"
                ]
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the informational catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LastUpdatedDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the informational catalog was last updated.",
            "format":"date-time",
            "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
            }
        },
        "categoryAssignments":{
            "title":"Category Assignments",
            "type":"array",
            "description":"Details of the categories assigned to the informational catalog for browsing.",
            "items":{
                "$ref":"#/components/schemas/informationalCatalogs-categoryAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Category Assignments

Type: array

Title: Category Assignments

Details of the categories assigned to the informational catalog for browsing.

Show Source

• Array of: object informationalCatalogs-categoryAssignments-item-response

{
    "title":"Category Assignments",
    "type":"array",
    "description":"Details of the categories assigned to the informational catalog for browsing.",
    "items":{
        "$ref":"#/components/schemas/informationalCatalogs-categoryAssignments-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 : informationalCatalogs-categoryAssignments-item-response

Type: object

Show Source

• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 20

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

  Unique identifier of the category assignment to the informational 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: 250

  Name of the category assigned to the informational catalog.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the category assignment was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 250

  Brief description about the category.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the category assignment.
• LastUpdatedDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the category assignment was last updated.
• 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 the assigned category. Valid values are PURCHASING_CATEGORY for purchasing and BROWSING_CATEGORY for browsing.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CatalogAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the category assignment to the informational 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":250,
            "type":"string",
            "description":"Name of the category assigned to the informational catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the category assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the category assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"Brief description about the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
            }
        },
        "LastUpdatedDate":{
            "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
            }
        },
        "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."
        }
    }
}

Links

addCategoryAssignments

Operation: /fscmRestApi/resources/11.13.18.05/informationalCatalogs/{CatalogId}/action/addCategoryAssignments

Parameters:

• CatalogId: $request.path.CatalogId

Adds category assignments for browsing to the informational catalog.

categoryAssignments

Operation: /fscmRestApi/resources/11.13.18.05/informationalCatalogs/{CatalogId}/child/categoryAssignments

Parameters:

• CatalogId: $request.path.CatalogId

Details of the categories assigned to the informational catalog for browsing.

Back to Top