Create one clipboard entry
post
/fscmRestApi/resources/11.13.18.05/clipboardEntriesV2
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
Root Schema : schema
Type:
Show Source
object
-
ClipboardEntryId: integer
(int64)
ID of the clipboard entry.
-
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(required): string
Maximum Length:
4000
Name of the clipboard entry. -
ObjectContext1(required): 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(required): 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(required): 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.
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
Nested Schema : clipboardEntriesV2-ObjectTagSet-item-post-request
Type:
Show Source
object
-
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.
-
TagId: integer
(int64)
Value that uniquely identifies the object tag set.
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 : clipboardEntriesV2-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : clipboardEntriesV2-ObjectTagSet-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ObjectTagSet
-
Operation: /fscmRestApi/resources/11.13.18.05/clipboardEntriesV2/{ClipboardEntryId}/child/ObjectTagSetParameters:
- 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. - ClipboardEntryId: