Jump to

• Request
• Response

Create inventory attribute setup

post

/fscmRestApi/resources/11.13.18.05/inventoryAttributeSetups

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApplicabilityCode(required): string
  Maximum Length: 30

  Unique identifier of the applicability code for an inventory attribute.
• attributeApplicabilities: array Inventory Attribute Applicabilities
  Title: Inventory Attribute Applicabilities

  Applicability of the inventory tracking attribute.
• AttributeCode(required): string
  Maximum Length: 30

  Indicates the descriptive flexfield segment code for which the attribute setup is applicable.
• attributeMappings: array Inventory Attribute Mapping Rules
  Title: Inventory Attribute Mapping Rules

  Attribute mapping rules for the inventory tracking attributes.
• EnabledFlag(required): boolean
  Maximum Length: 1

  Indicates whether the attribute is enabled for inventory tracking.
• OverrideAllowedFlag(required): boolean
  Maximum Length: 1

  Unique identifier of the applicability code for an inventory attribute.
• RequiredFlag(required): boolean
  Maximum Length: 1

  Indicates whether a nonnull value must be specified for the attribute during transactions that increment on-hand quantity.
• ReservationsAllowedFlag(required): boolean
  Maximum Length: 1

  Indicates whether a reservation can be created using the inventory attribute.

{
    "required":[
        "ApplicabilityCode",
        "AttributeCode",
        "EnabledFlag",
        "OverrideAllowedFlag",
        "RequiredFlag",
        "ReservationsAllowedFlag"
    ],
    "type":"object",
    "properties":{
        "ApplicabilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the applicability code for an inventory attribute.",
            "nullable":false
        },
        "AttributeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the descriptive flexfield segment code for which the attribute setup is applicable.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute is enabled for inventory tracking.",
            "nullable":false
        },
        "OverrideAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Unique identifier of the applicability code for an inventory attribute.",
            "nullable":false
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a nonnull value must be specified for the attribute during transactions that increment on-hand quantity.",
            "nullable":false
        },
        "ReservationsAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a reservation can be created using the inventory attribute.",
            "nullable":false
        },
        "attributeApplicabilities":{
            "title":"Inventory Attribute Applicabilities",
            "type":"array",
            "description":"Applicability of the inventory tracking attribute.",
            "items":{
                "$ref":"#/components/schemas/inventoryAttributeSetups-attributeApplicabilities-item-post-request"
            }
        },
        "attributeMappings":{
            "title":"Inventory Attribute Mapping Rules",
            "type":"array",
            "description":"Attribute mapping rules for the inventory tracking attributes.",
            "items":{
                "$ref":"#/components/schemas/inventoryAttributeSetups-attributeMappings-item-post-request"
            }
        }
    }
}

Nested Schema : Inventory Attribute Applicabilities

Type: array

Title: Inventory Attribute Applicabilities

Applicability of the inventory tracking attribute.

Show Source

• Array of: object inventoryAttributeSetups-attributeApplicabilities-item-post-request

{
    "title":"Inventory Attribute Applicabilities",
    "type":"array",
    "description":"Applicability of the inventory tracking attribute.",
    "items":{
        "$ref":"#/components/schemas/inventoryAttributeSetups-attributeApplicabilities-item-post-request"
    }
}

Nested Schema : Inventory Attribute Mapping Rules

Type: array

Title: Inventory Attribute Mapping Rules

Attribute mapping rules for the inventory tracking attributes.

Show Source

• Array of: object schema

{
    "title":"Inventory Attribute Mapping Rules",
    "type":"array",
    "description":"Attribute mapping rules for the inventory tracking attributes.",
    "items":{
        "$ref":"#/components/schemas/inventoryAttributeSetups-attributeMappings-item-post-request"
    }
}

Nested Schema : inventoryAttributeSetups-attributeApplicabilities-item-post-request

Type: object

Show Source

• InventoryAttributeSetupId: integer (int64)
  Unique identifier of the inventory attribute setup associated with the inventory attribute applicability.
• ItemCatalogId: integer (int64)
  Unique identifier for the item catalog.
• ItemCategoryId: integer (int64)
  Unique identifier for the item category.
• OrganizationId: integer (int64)
  Unique identifier for the organization.

{
    "type":"object",
    "properties":{
        "InventoryAttributeSetupId":{
            "type":"integer",
            "description":"Unique identifier of the inventory attribute setup associated with the inventory attribute applicability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemCatalogId":{
            "type":"integer",
            "description":"Unique identifier for the item catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ItemCategoryId":{
            "type":"integer",
            "description":"Unique identifier for the item category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• InventoryAttributeSetupId: integer (int64)
  Unique identifier for the inventory attribute setup used in mapping.
• MappingObject: string
  Maximum Length: 30

  Unique identifier of the type of object for which mapping is defined.
• MappingObjectAttribute: string
  Maximum Length: 30

  Unique identifier of the attribute of the mapping object for which the mapping is defined.
• SourceType: string
  Maximum Length: 30

  Unique identifier of the source type for which mapping is defined.

{
    "type":"object",
    "properties":{
        "InventoryAttributeSetupId":{
            "type":"integer",
            "description":"Unique identifier for the inventory attribute setup used in mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MappingObject":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the type of object for which mapping is defined.",
            "nullable":false
        },
        "MappingObjectAttribute":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the attribute of the mapping object for which the mapping is defined.",
            "nullable":false
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the source type for which mapping is defined.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• ApplicabilityCode: string
  Maximum Length: 30

  Unique identifier of the applicability code for an inventory attribute.
• ApplicabilityCodeMeaning: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the meaning of the applicability code for an inventory attribute.
• attributeApplicabilities: array Inventory Attribute Applicabilities
  Title: Inventory Attribute Applicabilities

  Applicability of the inventory tracking attribute.
• AttributeCode: string
  Maximum Length: 30

  Indicates the descriptive flexfield segment code for which the attribute setup is applicable.
• attributeMappings: array Inventory Attribute Mapping Rules
  Title: Inventory Attribute Mapping Rules

  Attribute mapping rules for the inventory tracking attributes.
• AttributeName: string
  Read Only: true

  Maximum Length: 255

  Indicates the descriptive flexfield segment name for which the attribute setup is applicable.
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the attribute is enabled for inventory tracking.
• InventoryAttributeSetupId: integer (int64)
  Read Only: true

  Unique identifier for the inventory attribute setup.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverrideAllowedFlag: boolean
  Maximum Length: 1

  Unique identifier of the applicability code for an inventory attribute.
• RequiredFlag: boolean
  Maximum Length: 1

  Indicates whether a nonnull value must be specified for the attribute during transactions that increment on-hand quantity.
• ReservationsAllowedFlag: boolean
  Maximum Length: 1

  Indicates whether a reservation can be created using the inventory attribute.

{
    "type":"object",
    "properties":{
        "ApplicabilityCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the applicability code for an inventory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicabilityCodeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the meaning of the applicability code for an inventory attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttributeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the descriptive flexfield segment code for which the attribute setup is applicable.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the descriptive flexfield segment name for which the attribute setup is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attribute is enabled for inventory tracking.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryAttributeSetupId":{
            "type":"integer",
            "description":"Unique identifier for the inventory attribute setup.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OverrideAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Unique identifier of the applicability code for an inventory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a nonnull value must be specified for the attribute during transactions that increment on-hand quantity.",
            "nullable":false,
            "x-queryable":true
        },
        "ReservationsAllowedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a reservation can be created using the inventory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "attributeApplicabilities":{
            "title":"Inventory Attribute Applicabilities",
            "type":"array",
            "description":"Applicability of the inventory tracking attribute.",
            "items":{
                "$ref":"#/components/schemas/inventoryAttributeSetups-attributeApplicabilities-item-response"
            }
        },
        "attributeMappings":{
            "title":"Inventory Attribute Mapping Rules",
            "type":"array",
            "description":"Attribute mapping rules for the inventory tracking attributes.",
            "items":{
                "$ref":"#/components/schemas/inventoryAttributeSetups-attributeMappings-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Inventory Attribute Applicabilities

Type: array

Title: Inventory Attribute Applicabilities

Applicability of the inventory tracking attribute.

Show Source

• Array of: object inventoryAttributeSetups-attributeApplicabilities-item-response

{
    "title":"Inventory Attribute Applicabilities",
    "type":"array",
    "description":"Applicability of the inventory tracking attribute.",
    "items":{
        "$ref":"#/components/schemas/inventoryAttributeSetups-attributeApplicabilities-item-response"
    }
}

Nested Schema : Inventory Attribute Mapping Rules

Type: array

Title: Inventory Attribute Mapping Rules

Attribute mapping rules for the inventory tracking attributes.

Show Source

• Array of: object inventoryAttributeSetups-attributeMappings-item-response

{
    "title":"Inventory Attribute Mapping Rules",
    "type":"array",
    "description":"Attribute mapping rules for the inventory tracking attributes.",
    "items":{
        "$ref":"#/components/schemas/inventoryAttributeSetups-attributeMappings-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 : inventoryAttributeSetups-attributeApplicabilities-item-response

Type: object

Show Source

• InventoryAttributeApplicabilityId: integer (int64)
  Read Only: true

  Unique identifier for the applicability of an inventory attribute.
• InventoryAttributeSetupId: integer (int64)
  Unique identifier of the inventory attribute setup associated with the inventory attribute applicability.
• ItemCatalogCode: string
  Read Only: true

  Maximum Length: 30

  Unique identifier of the item catalog code.
• ItemCatalogId: integer (int64)
  Unique identifier for the item catalog.
• ItemCatalogName: string
  Read Only: true

  Maximum Length: 30

  Name of the item catalog.
• ItemCategoryCode: string
  Read Only: true

  Maximum Length: 820

  Unique identifier of the category code within a catalog.
• ItemCategoryId: integer (int64)
  Unique identifier for the item category.
• ItemCategoryName: string
  Read Only: true

  Maximum Length: 2400

  Name of the item category.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Unique identifier of the organization code.
• OrganizationId: integer (int64)
  Unique identifier for the organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization.

{
    "type":"object",
    "properties":{
        "InventoryAttributeApplicabilityId":{
            "type":"integer",
            "description":"Unique identifier for the applicability of an inventory attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InventoryAttributeSetupId":{
            "type":"integer",
            "description":"Unique identifier of the inventory attribute setup associated with the inventory attribute applicability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCatalogCode":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the item catalog code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ItemCatalogId":{
            "type":"integer",
            "description":"Unique identifier for the item catalog.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCatalogName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the item catalog.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ItemCategoryCode":{
            "maxLength":820,
            "type":"string",
            "description":"Unique identifier of the category code within a catalog.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemCategoryId":{
            "type":"integer",
            "description":"Unique identifier for the item category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemCategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the item category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Unique identifier of the organization code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : inventoryAttributeSetups-attributeMappings-item-response

Type: object

Show Source

• InventoryAttributeMappingId: integer (int64)
  Read Only: true

  Unique identifier for the inventory attribute mapping rule.
• InventoryAttributeSetupId: integer (int64)
  Unique identifier for the inventory attribute setup used in mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingObject: string
  Maximum Length: 30

  Unique identifier of the type of object for which mapping is defined.
• MappingObjectAttribute: string
  Maximum Length: 30

  Unique identifier of the attribute of the mapping object for which the mapping is defined.
• SourceType: string
  Maximum Length: 30

  Unique identifier of the source type for which mapping is defined.
• SourceTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Unique identifier of the meaning of the source type for which mapping is defined.

{
    "type":"object",
    "properties":{
        "InventoryAttributeMappingId":{
            "type":"integer",
            "description":"Unique identifier for the inventory attribute mapping rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InventoryAttributeSetupId":{
            "type":"integer",
            "description":"Unique identifier for the inventory attribute setup used in mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MappingObject":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the type of object for which mapping is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "MappingObjectAttribute":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the attribute of the mapping object for which the mapping is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of the source type for which mapping is defined.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Unique identifier of the meaning of the source type for which mapping is defined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attributeApplicabilities

Operation: /fscmRestApi/resources/11.13.18.05/inventoryAttributeSetups/{InventoryAttributeSetupId}/child/attributeApplicabilities

Parameters:

• InventoryAttributeSetupId: $request.path.InventoryAttributeSetupId

Applicability of the inventory tracking attribute.

attributeMappings

Operation: /fscmRestApi/resources/11.13.18.05/inventoryAttributeSetups/{InventoryAttributeSetupId}/child/attributeMappings

Parameters:

• InventoryAttributeSetupId: $request.path.InventoryAttributeSetupId

Attribute mapping rules for the inventory tracking attributes.

Back to Top