Jump to

• Request
• Response

Create business unit assignments

post

/fscmRestApi/resources/11.13.18.05/recallNoticesV2/{HeaderId}/child/recallBusinessUnits

Request

Path Parameters

• HeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignedBUId: integer (int64)
  Value that uniquely identifies the business unit.
• AssignedBUName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice.
• ObjectVersionNumber: integer (int32)
  Number of times the business unit assignment was updated.
• RecBUAssignmentId: integer (int64)
  Value that uniquely identifies the business unit assignment.

{
    "type":"object",
    "properties":{
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssignedBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RecBUAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the business unit assignment was updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "AssignedBUName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : recallNoticesV2-recallBusinessUnits-item-response

Type: object

Show Source

• AssignedBUId: integer (int64)
  Value that uniquely identifies the business unit.
• AssignedBUName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who created the business unit assignment.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the user created the business unit assignment.
• HeaderId: integer (int64)
  Value that uniquely identifies the recall notice.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the business unit assignment.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who most recently updated the business unit assignment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Code that uniquely identifies the user who most recently updated the business unit assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number of times the business unit assignment was updated.
• RecBUAssignmentId: integer (int64)
  Value that uniquely identifies the business unit assignment.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who most recently updated the business unit assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the user created the business unit assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who created the business unit assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecBUAssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the business unit assignment was updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the recall notice.",
            "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"
            }
        },
        "AssignedBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the business unit assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Code that uniquely identifies the user who most recently updated the business unit assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedBUName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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