REST API for Oracle Fusion Cloud SCM

Get all item catalogs

get

/fscmRestApi/resources/11.13.18.05/itemCatalogs

Request

Query Parameters

expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey :Find item catalogs according to the primary key criteria.
  Finder Variables:
  - CatalogId :Value that uniquely identifies the item catalog.
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:
- AllowItemToMultipleCategoriesFlag; boolean; Contains one of the following values: true or false. If true, then an item can be assigned to multiple categories in the catalog. If false, then an item can only be assigned to a single category in the catalog. The default value is false.
- AssignItemsToLeafOnlyFlag; boolean; Contains one of the following values: true or false. If true, then an item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then an item can only be assigned to any category in the catalog. The default value is true.
- CatalogCode; string; Abbreviation that identifies the catalog.
- CatalogId; integer; Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.
- CatalogName; string; Name of the catalog.
- CreationDateTime; string; Date and time when the user created the catalog.
- DefaultCategoryCode; string; Abbreviation that identifies the default category specified for a catalog. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.
- Description; string; Description of the catalog.
- EndDate; string; Date when the catalog becomes inactive.
- HierarchyEnabledFlag; boolean; Contains one of the following values: true or false. If true, then the item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then the item can only be assigned to any category in the catalog. The default value is true.
- LastUpdateDateTime; string; Date and time when the user most recently updated the catalog.
- MasterControlledFlag; boolean; Contains the following values: Master Level or Organization Level. Master Level enables automatic assignment of the items assigned to a category to be assigned to all child organizations. Organization Level assigns the item only to the organization in the current context. The default value is Master Level.
- PublicCatalogFlag; boolean; Contains one of the following values: true or false. If true, then the catalog is accessible to all users and groups. If false, then the catalog accessibility is controlled by data security policies. The default value is true.
- StartDate; string; Date when the catalog becomes active.
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: 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.

There's no request body for this operation.

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.

Root Schema : itemCatalogs

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"ProductLifecycleManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object itemCatalogs-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-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 : itemCatalogs-item-response

Type: object

Show Source

AllowItemToMultipleCategoriesFlag: boolean

Title: Allow multiple item category assignments

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then an item can be assigned to multiple categories in the catalog. If false, then an item can only be assigned to a single category in the catalog. The default value is false.
AssignItemsToLeafOnlyFlag: boolean

Title: Catalog Content

Maximum Length: 30

Default Value: true

Contains one of the following values: true or false. If true, then an item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then an item can only be assigned to any category in the catalog. The default value is true.
attachments: array Attachments

Title: Attachments

The Attachments resource manages the catalog attachments.
CatalogCode: string

Maximum Length: 30

Abbreviation that identifies the catalog.
CatalogId: integer (int64)

Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.
CatalogName: string

Maximum Length: 30

Name of the catalog.
categoryHierarchies: array Category Hierarchies

Title: Category Hierarchies

The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.
CreationDateTime: string (date-time)

Read Only: true

Date and time when the user created the catalog.
DefaultCategoryCode: string

Maximum Length: 255

Abbreviation that identifies the default category specified for a catalog. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.
Description: string

Maximum Length: 240

Description of the catalog.
DFF: array DFF
EndDate: string (date)

Date when the catalog becomes inactive.
functionalAreaAssignments: array Functional Area Assignments

Title: Functional Area Assignments

The Functional Area Catalog Mappings resource gets the catalogs assigned to a functional area and the functional areas assigned to a catalog.
HierarchyEnabledFlag: boolean

Title: Enable hierarchies for categories.

Read Only: true

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then the item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then the item can only be assigned to any category in the catalog. The default value is true.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the catalog.
links: array Links

Title: Links

The link relations associated with the resource instance.
MasterControlledFlag: boolean

Title: Controlled At

Default Value: true

Contains the following values: Master Level or Organization Level. Master Level enables automatic assignment of the items assigned to a category to be assigned to all child organizations. Organization Level assigns the item only to the organization in the current context. The default value is Master Level.
PublicCatalogFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then the catalog is accessible to all users and groups. If false, then the catalog accessibility is controlled by data security policies. The default value is true.
StartDate: string (date)

Date when the catalog becomes active.
translatableAttributes: array Translatable Attributes

Title: Translatable Attributes

The Translatable Attributes resource manages the translatable attributes of item catalog.

{
    "type":"object",
    "properties":{
        "AllowItemToMultipleCategoriesFlag":{
            "title":"Allow multiple item category assignments",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then an item can be assigned to multiple categories in the catalog. If false, then an item can only be assigned to a single category in the catalog. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssignItemsToLeafOnlyFlag":{
            "title":"Catalog Content",
            "maxLength":30,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then an item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then an item can only be assigned to any category in the catalog. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "CatalogCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the catalog.",
            "nullable":false,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the catalog.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DefaultCategoryCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the default category specified for a catalog. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the catalog.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the catalog becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "HierarchyEnabledFlag":{
            "title":"Enable hierarchies for categories.",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item can be assigned to lowest level of categories in an hierarchy in the catalog. If false, then the item can only be assigned to any category in the catalog. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the catalog.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterControlledFlag":{
            "title":"Controlled At",
            "type":"boolean",
            "description":"Contains the following values: Master Level or Organization Level. Master Level enables automatic assignment of the items assigned to a category to be assigned to all child organizations. Organization Level assigns the item only to the organization in the current context. The default value is Master Level.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PublicCatalogFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the catalog is accessible to all users and groups. If false, then the catalog accessibility is controlled by data security policies. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the catalog becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages the catalog attachments.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-attachments-item-response"
            }
        },
        "categoryHierarchies":{
            "title":"Category Hierarchies",
            "type":"array",
            "description":"The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-categoryHierarchies-item-response"
            }
        },
        "functionalAreaAssignments":{
            "title":"Functional Area Assignments",
            "type":"array",
            "description":"The Functional Area Catalog Mappings resource gets the catalogs assigned to a functional area and the functional areas assigned to a catalog.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-functionalAreaAssignments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translatableAttributes":{
            "title":"Translatable Attributes",
            "type":"array",
            "description":"The Translatable Attributes resource manages the translatable attributes of item catalog.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-translatableAttributes-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages the catalog attachments.

Show Source

Array of: object itemCatalogs-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages the catalog attachments.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-attachments-item-response"
    }
}

Nested Schema : Category Hierarchies

Type: array

Title: Category Hierarchies

The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.

Show Source

Array of: object itemCatalogs-categoryHierarchies-item-response

{
    "title":"Category Hierarchies",
    "type":"array",
    "description":"The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-categoryHierarchies-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

Array of: object itemCatalogs-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-DFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Functional Area Assignments

Type: array

Title: Functional Area Assignments

The Functional Area Catalog Mappings resource gets the catalogs assigned to a functional area and the functional areas assigned to a catalog.

Show Source

Array of: object itemCatalogs-functionalAreaAssignments-item-response

{
    "title":"Functional Area Assignments",
    "type":"array",
    "description":"The Functional Area Catalog Mappings resource gets the catalogs assigned to a functional area and the functional areas assigned to a catalog.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-functionalAreaAssignments-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 : Translatable Attributes

Type: array

Title: Translatable Attributes

The Translatable Attributes resource manages the translatable attributes of item catalog.

Show Source

Array of: object itemCatalogs-translatableAttributes-item-response

{
    "title":"Translatable Attributes",
    "type":"array",
    "description":"The Translatable Attributes resource manages the translatable attributes of item catalog.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-translatableAttributes-item-response"
    }
}

Nested Schema : itemCatalogs-attachments-item-response

Type: object

Show Source

attachmentDFF: array Descriptive Flexfields for Attachments

Title: Descriptive Flexfields for Attachments

The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.
CategoryName: string

Title: Category

Maximum Length: 30

Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.
ContentRepositoryFileShared: boolean

Title: Shared

Contains one of the following values: true or false. If true, then the attachment is shared. If false, then it's not shared. The default value is false.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 255

User who created the attachment.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date when the user created the attachment.
DatatypeCode: string

Title: Type

Maximum Length: 30

Default Value: FILE

Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
Description: string

Title: Description

Maximum Length: 255

Description of the catalog attachment.
DmFolderPath: string

Title: Dm Folder Path

Maximum Length: 1000

Path to the folder in which the attached file is uploaded.
DocumentURL: string

Read Only: true

Uniform resource locator of the catalog attachment.
DownloadInfo: string

Title: DownloadInfo

JSON object represented as a string containing information used to programmatically retrieve a file attachment.
ErrorStatusCode: string

Title: Error Status Code

Abbreviation that identifies the error code, if any, for the attachment.
ErrorStatusMessage: string

Title: Error Status Message

Text of the error message, if any, for the attachment.
FileName: string

Title: File Name

Maximum Length: 2048

Name of the file attached to the item.
FileUrl: string

Title: File Url

Uniform resource locator of the attachment file.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when the user most recently updated the attachment.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 255

User who most recently updated the attachment.
links: array Links

Title: Links

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

Title: Title

Title of the catalog attachment.
UploadedFileContentType: string

Title: Uploaded File Content Type

Type of the file content.
UploadedFileLength: integer

Title: File Size

Size of the attached file.
UploadedFileName: string

Title: Uploaded File Name

Name of the attached file.
UploadedText: string

Title: Uploaded Text

Content of the attached text file.
Uri: string

Title: Uri

Maximum Length: 4000

Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
Url: string

Title: Url

Maximum Length: 4000

Uniform resource locator of the attachment.
UserName: string

Title: User Name

Read Only: true

Maximum Length: 255

Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"Name of the catalog attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Attachment Categories task.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the attachment is shared. If false, then it's not shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the catalog attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"Path to the folder in which the attached file is uploaded.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DocumentURL":{
            "type":"string",
            "description":"Uniform resource locator of the catalog attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Abbreviation that identifies the error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Text of the error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"Name of the file attached to the item.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"Uniform resource locator of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the user most recently updated the attachment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"User who most recently updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the catalog attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of the file content.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Size of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Content of the attached text file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform resource identifier appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"Uniform resource locator of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "attachmentDFF":{
            "title":"Descriptive Flexfields for Attachments",
            "type":"array",
            "description":"The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-attachments-attachmentDFF-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Descriptive Flexfields for Attachments

Type: array

Title: Descriptive Flexfields for Attachments

The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.

Show Source

Array of: object itemCatalogs-attachments-attachmentDFF-item-response

{
    "title":"Descriptive Flexfields for Attachments",
    "type":"array",
    "description":"The Descriptive Flexfields for Attachments resource manages the contextual descriptive flexfields of the item catalog attachments.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-attachments-attachmentDFF-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 : itemCatalogs-attachments-attachmentDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 150

Descriptive flexfield context name for item catalog attachments.
__FLEX_Context_DisplayValue: string

Title: Context Segment

Descriptive flexfield context display value for item catalog attachments.
AttachedDocumentId: integer (int64)
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AttachedDocumentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context name for item catalog attachments.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for item catalog attachments.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : itemCatalogs-categoryHierarchies-item-response

Type: object

Show Source

CatalogCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the catalog.
CatalogId: integer

Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.
CategoryCode: string

Maximum Length: 820

Abbreviation that identifies the category.
categoryHierarchies: array Category Hierarchies

Title: Category Hierarchies

The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.
CategoryId: integer (int64)

Title: Default Category

Value that uniquely identifies the category.
CategoryName: string

Maximum Length: 250

Name of the category. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.
CreationDateTime: string (date-time)

Read Only: true

Date and time when the user created the category hierarchy.
Description: string

Maximum Length: 240

Description of the category.
EndDate: string (date)

Date when the category becomes inactive.
ItemsOnlyFlag: boolean

Title: Category Content

Maximum Length: 30

Default Value: false

Contains one of the following values: true or false. If true, then the category can be used only for item assignment. If false, then hierarchy can be created for the category. The default value is false.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the category.
links: array Links

Title: Links

The link relations associated with the resource instance.
ParentCategoryCode: string

Read Only: true

Maximum Length: 820

Abbreviation that identifies the category set as the parent category.
ParentCategoryId: integer

Value that uniquely identifies the category set as the parent category.
SharedFlag: boolean

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the category hierarchy is shared. If false, then the hierarchy is copied and not shared. The default value is false.
StartDate: string (date)

Date when the category becomes active.

{
    "type":"object",
    "properties":{
        "CatalogCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.",
            "nullable":false,
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":false,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Default Category",
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the category. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the category hierarchy.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the category becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemsOnlyFlag":{
            "title":"Category Content",
            "maxLength":30,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category can be used only for item assignment. If false, then hierarchy can be created for the category. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the category.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the category set as the parent category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set as the parent category.",
            "nullable":true,
            "x-queryable":true
        },
        "SharedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category hierarchy is shared. If false, then the hierarchy is copied and not shared. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the category becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "categoryHierarchies":{
            "title":"Category Hierarchies",
            "type":"array",
            "description":"The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.",
            "items":{
                "$ref":"#/components/schemas/itemCatalogs-categoryHierarchies-categoryHierarchies-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Category Hierarchies

Type: array

Title: Category Hierarchies

The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.

Show Source

Array of: object itemCatalogs-categoryHierarchies-categoryHierarchies-item-response

{
    "title":"Category Hierarchies",
    "type":"array",
    "description":"The Category Hierarchies resource organizes the categories of an item catalog in a hierarchy.",
    "items":{
        "$ref":"#/components/schemas/itemCatalogs-categoryHierarchies-categoryHierarchies-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 : itemCatalogs-categoryHierarchies-categoryHierarchies-item-response

Type: object

Show Source

CatalogCode: string

Read Only: true

Maximum Length: 30

Abbreviation that identifies the catalog.
CatalogId: integer

Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.
CategoryCode: string

Maximum Length: 820

Abbreviation that identifies the category.
CategoryId: integer (int64)

Title: Default Category

Value that uniquely identifies the category.
CategoryName: string

Maximum Length: 250

Name of the category. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.
CreationDateTime: string (date-time)

Read Only: true

Date and time when the user created the category hierarchy.
Description: string

Maximum Length: 240

Description of the category.
EndDate: string (date)

Date when the category becomes inactive.
ItemsOnlyFlag: boolean

Title: Category Content

Maximum Length: 30

Default Value: false

Contains one of the following values: true or false. If true, then the category can be used only for item assignment. If false, then hierarchy can be created for the category. The default value is false.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the category.
links: array Links

Title: Links

The link relations associated with the resource instance.
ParentCategoryCode: string

Read Only: true

Maximum Length: 820

Abbreviation that identifies the category set as the parent category.
ParentCategoryId: integer

Value that uniquely identifies the category set as the parent category.
SharedFlag: boolean

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the category hierarchy is shared. If false, then the hierarchy is copied and not shared. The default value is false.
StartDate: string (date)

Date when the category becomes active.

{
    "type":"object",
    "properties":{
        "CatalogCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the catalog.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.",
            "nullable":false,
            "x-queryable":true
        },
        "CategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the category.",
            "nullable":false,
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Default Category",
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":250,
            "type":"string",
            "description":"Name of the category. Review and update the value for this attribute using the Items work area, and the Manage Catalogs task.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the category hierarchy.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the category.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the category becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ItemsOnlyFlag":{
            "title":"Category Content",
            "maxLength":30,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category can be used only for item assignment. If false, then hierarchy can be created for the category. The default value is false.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the category.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Abbreviation that identifies the category set as the parent category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category set as the parent category.",
            "nullable":true,
            "x-queryable":true
        },
        "SharedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category hierarchy is shared. If false, then the hierarchy is copied and not shared. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the category becomes active.",
            "format":"date",
            "nullable":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 : itemCatalogs-DFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment
CategorySetId: integer (int64)
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CategorySetId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : itemCatalogs-functionalAreaAssignments-item-response

Type: object

Show Source

FunctionalAreaId: integer (int64)

Title: Functional Area

Value that uniquely identifies the functional area.
FunctionalAreaName: string

Maximum Length: 255

Name of the functional area.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the functional area.
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FunctionalAreaId":{
            "title":"Functional Area",
            "type":"integer",
            "description":"Value that uniquely identifies the functional area.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FunctionalAreaName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the functional area.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the functional area.",
            "format":"date-time",
            "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 : itemCatalogs-translatableAttributes-item-response

Type: object

Show Source

CatalogId: integer (int64)

Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.
CatalogName: string

Maximum Length: 30

Translated name of the catalog.
CreationDateTime: string (date-time)

Read Only: true

Date and time when the user created the translatable attributes.
Description: string

Maximum Length: 240

Translated description of the catalog.
Language: string

Maximum Length: 4

Language associated with the translated catalog attributes.
LastUpdateDateTime: string (date-time)

Read Only: true

Date and time when the user most recently updated the translatable attributes.
links: array Links

Title: Links

The link relations associated with the resource instance.
SourceLanguage: string

Maximum Length: 4

Language associated with the translated source catalog attributes.

{
    "type":"object",
    "properties":{
        "CatalogId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog. This value should not be used in service calls to create catalogs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Translated name of the catalog.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Date and time when the user created the translatable attributes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Translated description of the catalog.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the translated catalog attributes.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Date and time when the user most recently updated the translatable attributes.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"Language associated with the translated source catalog attributes.",
            "nullable":false,
            "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"
    }
}

Links

assignCatalogToFunctionalArea: Operation: /fscmRestApi/resources/11.13.18.05/itemCatalogs/action/assignCatalogToFunctionalArea

Assigns an item catalog to the specified functional area.

Examples

This example describes how to get all item catalogs.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemCatalogs"

For example, the following command gets all item catalogs that start with a given phrase:

curl -u username:password "https://servername/fscmRestApi/resources/version/itemCatalogs?q=CatalogName LIKE AI%"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"CatalogId": 300100075558987,
		"CatalogCode": "AI_Catalog",
		"CatalogName": "AI_Catalog",
		"Description": "AI_Catalog\n",
		"MasterControlledFlag": true,
		"StartDate": "2015-12-06",
		"EndDate": null,
		"AssignItemsToLeafOnlyFlag": true,
		"AllowItemToMultipleCategoriesFlag": false,
		"PublicCatalogFlag": true,
		"DefaultCategoryCode": null,
		"HierarchyEnabledFlag": false,
		"CreationDateTime": "2015-12-06T08:30:05.380+00:00",
		"LastUpdateDateTime": "2015-12-06T08:30:48.742+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987",
			"name": "itemCatalogs",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987",
			"name": "itemCatalogs",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987/child/DFF",
			"name": "DFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987/child/categoryHierarchies",
			"name": "categoryHierarchies",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987/child/functionalAreaAssignments",
			"name": "functionalAreaAssignments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100075558987/child/translatableAttributes",
			"name": "translatableAttributes",
			"kind": "collection"
		}
		]
	},
	{
		"CatalogId": 300100081288135,
		"CatalogCode": "AI_SUP_Catalog",
		"CatalogName": "AI_SUP_Catalog",
		"Description": "AI_SUP_Catalog\n",
		"MasterControlledFlag": true,
		"StartDate": "2015-12-08",
		"EndDate": null,
		"AssignItemsToLeafOnlyFlag": true,
		"AllowItemToMultipleCategoriesFlag": true,
		"PublicCatalogFlag": true,
		"DefaultCategoryCode": null,
		"HierarchyEnabledFlag": false,
		"CreationDateTime": "2015-12-08T18:24:22.002+00:00",
		"LastUpdateDateTime": "2019-03-04T06:46:42.733+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135",
			"name": "itemCatalogs",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135",
			"name": "itemCatalogs",
			"kind": "item"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135/child/DFF",
			"name": "DFF",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135/child/attachments",
			"name": "attachments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135/child/categoryHierarchies",
			"name": "categoryHierarchies",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135/child/functionalAreaAssignments",
			"name": "functionalAreaAssignments",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/itemCatalogs/300100081288135/child/translatableAttributes",
			"name": "translatableAttributes",
			"kind": "collection"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/itemCatalogs",
		"name": "itemCatalogs",
		"kind": "collection"
	}
	]
}