Jump to

• Request
• Response

Update an assignment

patch

/fscmRestApi/resources/11.13.18.05/assetGroups/{GroupId}/child/assignments/{GroupMemberId}

Request

Path Parameters

• GroupId(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=
• GroupMemberId(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

• AssetId: integer (int64)
  Value that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  Date when the assignment becomes inactive. This attribute is read-only.
• GroupId: integer (int64)
  Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.
• GroupMemberId: integer (int64)
  Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.",
            "nullable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"Date when the assignment becomes inactive. This attribute is read-only.",
            "format":"date",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

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 : assetGroups-assignments-item-response

Type: object

Show Source

• AssetId: integer (int64)
  Value that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
• AssetNumber: string
  Maximum Length: 255

  Number that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.
• AssignmentEndDate: string (date)
  Title: Assignment End Date

  Date when the assignment becomes inactive. This attribute is read-only.
• CustomerName: string
  Read Only: true

  Maximum Length: 255

  Customer name of the assignment in the asset group.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the assignment in the asset group.
• GroupId: integer (int64)
  Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.
• GroupMemberId: integer (int64)
  Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.
• ItemNumber: string
  Read Only: true

  Maximum Length: 255

  Item number of the assignment in the asset group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number of the assignments in the asset group.

{
    "type":"object",
    "properties":{
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the asset belonging to the group. You can provide either the asset identifier or the asset number to create an asset group assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentEndDate":{
            "title":"Assignment End Date",
            "type":"string",
            "description":"Date when the assignment becomes inactive. This attribute is read-only.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"Customer name of the assignment in the asset group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the assignment in the asset group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group. This value is automatically populated from the parent group. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. The application generates this value when it creates the assignment. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Item number of the assignment in the asset group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Serial number of the assignments in the asset group.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top