Jump to

• Request
• Response

Update one clipboard entry

patch

/fscmRestApi/resources/11.13.18.05/clipboardEntriesV2/{ClipboardEntryId}

Request

Path Parameters

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

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClipboardEntrySource: string
  Maximum Length: 250

  Value that indicates the source of the clipboard entry.
• Description: string
  Description of the object added to the clipboard.
• ImageURL: string
  Maximum Length: 240

  URL of the image of the clipboard entry.
• Name: string
  Maximum Length: 4000

  Name of the clipboard entry.
• ObjectContext1: string
  Maximum Length: 4000

  Object's context value from the first column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext2: string
  Maximum Length: 4000

  Object's context value from the second column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext3: string
  Maximum Length: 4000

  Object's context value from the third column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext4: string
  Maximum Length: 4000

  Object's context value from the fourth column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext5: string
  Maximum Length: 4000

  Object's context value from the fifth column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectTagSet: array Object Tag Sets
  Title: Object Tag Sets

  A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.
• ObjectType: string
  Maximum Length: 80

  Value that identifies the object type of the clipboard entry.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization of the clipboard entry.
• Pinned: string
  Maximum Length: 4

  Default Value: N

  Value that indicates if the clipboard entry is pinned.
• Pk1Value: integer (int64)
  First column that stores a primary key for the object. For the Item object, the primary key is the inventory item ID.
• Pk2Value: integer (int64)
  Second column that stores a primary key for the object. For the Item object, the primary key is the organization ID.
• Pk3Value: integer (int64)
  Third column that stores a primary key for the object. For the Item object, the primary key is the revision ID.
• Pk4Value: integer (int64)
  Primary key value of the clipboard entry from the fourth column.
• Pk5Value: integer (int64)
  Primary key value of the clipboard entry from the fifth column.
• Pk6Value: string
  Maximum Length: 100

  Primary key value of the clipboard entry from the sixth column.
• Pk7Value: string
  Maximum Length: 100

  Primary key value of the clipboard entry from the seventh column.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of the object added to the clipboard.",
            "nullable":true
        },
        "Pk1Value":{
            "type":"integer",
            "description":"First column that stores a primary key for the object. For the Item object, the primary key is the inventory item ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Pk5Value":{
            "type":"integer",
            "description":"Primary key value of the clipboard entry from the fifth column.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Pinned":{
            "maxLength":4,
            "type":"string",
            "description":"Value that indicates if the clipboard entry is pinned.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Pk4Value":{
            "type":"integer",
            "description":"Primary key value of the clipboard entry from the fourth column.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ImageURL":{
            "maxLength":240,
            "type":"string",
            "description":"URL of the image of the clipboard entry.",
            "nullable":true
        },
        "Pk7Value":{
            "maxLength":100,
            "type":"string",
            "description":"Primary key value of the clipboard entry from the seventh column.",
            "nullable":true
        },
        "ObjectTagSet":{
            "title":"Object Tag Sets",
            "type":"array",
            "description":"A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.",
            "items":{
                "$ref":"#/components/schemas/clipboardEntriesV2-ObjectTagSet-item-patch-request"
            }
        },
        "Pk2Value":{
            "type":"integer",
            "description":"Second column that stores a primary key for the object. For the Item object, the primary key is the organization ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the clipboard entry.",
            "nullable":false
        },
        "ObjectContext5":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the fifth column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true
        },
        "Pk3Value":{
            "type":"integer",
            "description":"Third column that stores a primary key for the object. For the Item object, the primary key is the revision ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClipboardEntrySource":{
            "maxLength":250,
            "type":"string",
            "description":"Value that indicates the source of the clipboard entry.",
            "nullable":true
        },
        "ObjectContext4":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the fourth column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true
        },
        "ObjectType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the object type of the clipboard entry.",
            "nullable":false
        },
        "ObjectContext1":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the first column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":false
        },
        "ObjectContext3":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the third column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true
        },
        "ObjectContext2":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the second column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the clipboard entry.",
            "nullable":true
        },
        "Pk6Value":{
            "maxLength":100,
            "type":"string",
            "description":"Primary key value of the clipboard entry from the sixth column.",
            "nullable":true
        }
    }
}

Nested Schema : Object Tag Sets

Type: array

Title: Object Tag Sets

A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.

Show Source

• Array of: object schema

{
    "title":"Object Tag Sets",
    "type":"array",
    "description":"A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.",
    "items":{
        "$ref":"#/components/schemas/clipboardEntriesV2-ObjectTagSet-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EntityId: integer (int64)
  Value that uniquely identifies the entity for the object tag set.
• TagId: integer (int64)
  Value that uniquely identifies the object tag set.

{
    "type":"object",
    "properties":{
        "EntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity for the object tag set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TagId":{
            "type":"integer",
            "description":"Value that uniquely identifies the object tag set.",
            "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:
  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 : clipboardEntriesV2-item-response

Type: object

Show Source

• ClipboardEntryId: integer (int64)
  ID of the clipboard entry.
• ClipboardEntrySource: string
  Maximum Length: 250

  Value that indicates the source of the clipboard entry.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the clipboard entry.
• CreationDate: string (date-time)
  Read Only: true

  Date when the entry was added to the clipboard.
• Description: string
  Description of the object added to the clipboard.
• ImageURL: string
  Maximum Length: 240

  URL of the image of the clipboard entry.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the clipboard was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the clipboard entry.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login that the user used when updating the clipboard entry.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 4000

  Name of the clipboard entry.
• ObjectContext1: string
  Maximum Length: 4000

  Object's context value from the first column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext2: string
  Maximum Length: 4000

  Object's context value from the second column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext3: string
  Maximum Length: 4000

  Object's context value from the third column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext4: string
  Maximum Length: 4000

  Object's context value from the fourth column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectContext5: string
  Maximum Length: 4000

  Object's context value from the fifth column copied onto the clipboard. In case of the Items organization the name is stored in this field.
• ObjectTagSet: array Object Tag Sets
  Title: Object Tag Sets

  A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.
• ObjectType: string
  Maximum Length: 80

  Value that identifies the object type of the clipboard entry.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization of the clipboard entry.
• Pinned: string
  Maximum Length: 4

  Default Value: N

  Value that indicates if the clipboard entry is pinned.
• Pk1Value: integer (int64)
  First column that stores a primary key for the object. For the Item object, the primary key is the inventory item ID.
• Pk2Value: integer (int64)
  Second column that stores a primary key for the object. For the Item object, the primary key is the organization ID.
• Pk3Value: integer (int64)
  Third column that stores a primary key for the object. For the Item object, the primary key is the revision ID.
• Pk4Value: integer (int64)
  Primary key value of the clipboard entry from the fourth column.
• Pk5Value: integer (int64)
  Primary key value of the clipboard entry from the fifth column.
• Pk6Value: string
  Maximum Length: 100

  Primary key value of the clipboard entry from the sixth column.
• Pk7Value: string
  Maximum Length: 100

  Primary key value of the clipboard entry from the seventh column.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the entry was added to the clipboard.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "type":"string",
            "description":"Description of the object added to the clipboard.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk1Value":{
            "type":"integer",
            "description":"First column that stores a primary key for the object. For the Item object, the primary key is the inventory item ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClipboardEntryId":{
            "type":"integer",
            "description":"ID of the clipboard entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Pinned":{
            "maxLength":4,
            "type":"string",
            "description":"Value that indicates if the clipboard entry is pinned.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Pk4Value":{
            "type":"integer",
            "description":"Primary key value of the clipboard entry from the fourth column.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Pk7Value":{
            "maxLength":100,
            "type":"string",
            "description":"Primary key value of the clipboard entry from the seventh column.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the clipboard entry.",
            "nullable":false,
            "x-queryable":true
        },
        "Pk3Value":{
            "type":"integer",
            "description":"Third column that stores a primary key for the object. For the Item object, the primary key is the revision ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the object type of the clipboard entry.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization of the clipboard entry.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Pk6Value":{
            "maxLength":100,
            "type":"string",
            "description":"Primary key value of the clipboard entry from the sixth column.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the clipboard entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the clipboard entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pk5Value":{
            "type":"integer",
            "description":"Primary key value of the clipboard entry from the fifth column.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImageURL":{
            "maxLength":240,
            "type":"string",
            "description":"URL of the image of the clipboard entry.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTagSet":{
            "title":"Object Tag Sets",
            "type":"array",
            "description":"A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.",
            "items":{
                "$ref":"#/components/schemas/clipboardEntriesV2-ObjectTagSet-item-response"
            }
        },
        "Pk2Value":{
            "type":"integer",
            "description":"Second column that stores a primary key for the object. For the Item object, the primary key is the organization ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectContext5":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the fifth column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true,
            "x-queryable":true
        },
        "ClipboardEntrySource":{
            "maxLength":250,
            "type":"string",
            "description":"Value that indicates the source of the clipboard entry.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectContext4":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the fourth column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectContext1":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the first column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectContext3":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the third column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectContext2":{
            "maxLength":4000,
            "type":"string",
            "description":"Object's context value from the second column copied onto the clipboard. In case of the Items organization the name is stored in this field.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the clipboard was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login that the user used when updating the clipboard entry.",
            "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 : Object Tag Sets

Type: array

Title: Object Tag Sets

A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.

Show Source

• Array of: object clipboardEntriesV2-ObjectTagSet-item-response

{
    "title":"Object Tag Sets",
    "type":"array",
    "description":"A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.",
    "items":{
        "$ref":"#/components/schemas/clipboardEntriesV2-ObjectTagSet-item-response"
    }
}

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 : clipboardEntriesV2-ObjectTagSet-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the object tag set.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the object tag set.
• EntityId: integer (int64)
  Value that uniquely identifies the entity for the object tag set.
• Id: integer (int64)
  Value that uniquely identifies the row of the Id attribute.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the object tag set.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date and time when the user most recently updated the object tag set.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Date and time when the logged in user most recently updated the object tag set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagId: integer (int64)
  Value that uniquely identifies the object tag set.
• TagName: string
  Read Only: true

  Maximum Length: 255

  Name of the object tag set.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date and time when the user most recently updated the object tag set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity for the object tag set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the object tag set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the object tag set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TagName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the object tag set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TagId":{
            "type":"integer",
            "description":"Value that uniquely identifies the object tag set.",
            "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"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Value that uniquely identifies the row of the Id attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the object tag set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Date and time when the logged in user most recently updated the object tag set.",
            "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"
    }
}

Links

ObjectTagSet

Operation: /fscmRestApi/resources/11.13.18.05/clipboardEntriesV2/{ClipboardEntryId}/child/ObjectTagSet

Parameters:

• ClipboardEntryId: $request.path.ClipboardEntryId

A grouping of tags for objects that are displayed in the Navigator page. For example, a user selects items from a design to review a later time. These items are tagged by the user and added to a tag set for the user.

Back to Top