Jump to

• Request
• Response

Create attribute values

post

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/attributes/{attributesUniqID}/child/attributeValues

Request

Path Parameters

• OrganizationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• attributesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and AttributeId ---for the Attributes resource and used to uniquely identify an instance of Attributes. The client should not generate the hash key value. Instead, the client should query on the Attributes collection resource with a filter on the primary key values in order to navigate to a specific instance of Attributes.
  
  For example: attributes?q=OrganizationId=<value1>;AttributeId=<value2>

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  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

• AttributeId: integer (int64)
  Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
• AttributeValueCode: string
  Maximum Length: 300

  Abbreviation that identifies the attribute value.
• AttributeValueId: integer (int64)
  Value that uniquely identifies the attribute value. It's a primary key of the attribute value.
• AttributeValueName: string
  Maximum Length: 300

  Name of the attribute value.
• Color: string
  Maximum Length: 10

  Color associated with the attribute value that can be used for highlighting in the user interface. The attribute value is specified in hex color code that's common in HTML standards.
• Description: string
  Maximum Length: 2000

  Description of the associated attribute.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.

{
    "type":"object",
    "properties":{
        "AttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute value.",
            "nullable":false
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the associated attribute.",
            "nullable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute value. It's a primary key of the attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeValueName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the attribute value.",
            "nullable":true
        },
        "Color":{
            "maxLength":10,
            "type":"string",
            "description":"Color associated with the attribute value that can be used for highlighting in the user interface. The attribute value is specified in hex color code that's common in HTML standards.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : productionSchedulingOrganizations-attributes-attributeValues-item-response

Type: object

Show Source

• AttributeId: integer (int64)
  Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.
• AttributeValueCode: string
  Maximum Length: 300

  Abbreviation that identifies the attribute value.
• AttributeValueId: integer (int64)
  Value that uniquely identifies the attribute value. It's a primary key of the attribute value.
• AttributeValueName: string
  Maximum Length: 300

  Name of the attribute value.
• Color: string
  Maximum Length: 10

  Color associated with the attribute value that can be used for highlighting in the user interface. The attribute value is specified in hex color code that's common in HTML standards.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• Description: string
  Maximum Length: 2000

  Description of the associated attribute.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValueCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the attribute value.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":2000,
            "type":"string",
            "description":"Description of the associated attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute for an organization. It's a primary key of the attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the attribute value.",
            "nullable":true,
            "x-queryable":true
        },
        "Color":{
            "maxLength":10,
            "type":"string",
            "description":"Color associated with the attribute value that can be used for highlighting in the user interface. The attribute value is specified in hex color code that's common in HTML standards.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeValueId":{
            "type":"integer",
            "description":"Value that uniquely identifies the attribute value. It's a primary key of the attribute value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top