Jump to

• Request
• Response

Update existing associastions between installed base and fixed asset

patch

/fscmRestApi/resources/11.13.18.05/installedBaseAssets/{AssetId}/child/fixedAssetAssociations/{fixedAssetAssociationsUniqID}

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application generates this value when it creates the asset. This attribute is read-only.
• fixedAssetAssociationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Fixed Asset Associations resource and used to uniquely identify an instance of Fixed Asset Associations. The client should not generate the hash key value. Instead, the client should query on the Fixed Asset Associations collection resource in order to navigate to a specific instance of Fixed Asset Associations to get the hash key.

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

• ActiveEndDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes inactive.
• ActiveStartDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes active.
• AutoTerminationFlag: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset.
• FixedAssetId: integer (int64)
  Value that uniquely identifies the fixed asset.
• FixedAssetNumber: string
  Title: Fixed Asset Number

  Maximum Length: 255

  Number that uniquely identifies the fixed asset.
• TerminationReasonCode: string
  Maximum Length: 30

  Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.

{
    "type":"object",
    "properties":{
        "ActiveStartDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes active.",
            "format":"date-time",
            "nullable":true
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "AutoTerminationFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset.",
            "nullable":false
        },
        "TerminationReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.",
            "nullable":true
        },
        "FixedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fixed asset.",
            "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 : installedBaseAssets-fixedAssetAssociations-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes inactive.
• ActiveStartDate: string (date-time)
  Date and time when the association between installed base and fixed asset becomes active.
• AutoTerminationFlag: string
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset.
• FixedAssetId: integer (int64)
  Value that uniquely identifies the fixed asset.
• FixedAssetNumber: string
  Title: Fixed Asset Number

  Maximum Length: 255

  Number that uniquely identifies the fixed asset.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TerminationReasonCode: string
  Maximum Length: 30

  Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.

{
    "type":"object",
    "properties":{
        "ActiveStartDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AutoTerminationFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then the association is made inactive automatically. If false, then the association is not inactivated automatically. This attribute value is set conditionally during the updation of the asset.",
            "nullable":false,
            "x-queryable":true
        },
        "TerminationReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value when the autoTerminationFlag is set to yes. The value indicates the message code and the message text is displayed in the UI conditionally.",
            "nullable":true,
            "x-queryable":true
        },
        "FixedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fixed asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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