Jump to

• Request
• Response

Update existing associations between installed base and fixed asset

patch

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

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.
• FaAssociationId(required): integer(int64)
  Number that uniquely identifies the fixed asset association.

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

• 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.
• ErrorMessage: string
  Maximum Length: 4000

  Value that contains the errors encountered during the synchronization.
• FaAssociationId: integer (int64)
  Number that uniquely identifies the fixed asset association.
• FaBookTypeCode: string
  Maximum Length: 30

  Contains a value of the asset book on which the fixed asset is part of.
• 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.
• SynchronizationStatusCode: string
  Maximum Length: 30

  Value that identifies the status captured while enabling and tracking the synchronization.
• 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.
• ValidatedFlag: string
  Maximum Length: 1

  Value that identifies the association is valid and is eligible for synchronization between the two systems.

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes inactive.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveStartDate":{
            "type":"string",
            "description":"Date and time when the association between installed base and fixed asset becomes active.",
            "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
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that contains the errors encountered during the synchronization.",
            "nullable":true
        },
        "FaAssociationId":{
            "type":"integer",
            "description":"Number that uniquely identifies the fixed asset association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "FaBookTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value of the asset book on which the fixed asset is part of.",
            "nullable":true
        },
        "FixedAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the fixed asset.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true
        },
        "SynchronizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the status captured while enabling and tracking the synchronization.",
            "nullable":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
        },
        "ValidatedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the association is valid and is eligible for synchronization between the two systems.",
            "nullable":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 : 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.
• AttributeCategoryCode: string
  Read Only: true

  Maximum Length: 30

  Descriptive flexfield value for the fixed asset category.This attribute is read-only.
• 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.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 80

  Description of the fixed asset.This attribute is read-only.
• ErrorMessage: string
  Maximum Length: 4000

  Value that contains the errors encountered during the synchronization.
• FaAssetType: string
  Read Only: true

  Maximum Length: 255

  Type of the fixed asset.This attribute is read-only.
• FaAssociationId: integer (int64)
  Number that uniquely identifies the fixed asset association.
• FaBookTypeCode: string
  Maximum Length: 30

  Contains a value of the asset book on which the fixed asset is part of.
• 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.
• SerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 35

  Number that uniquely identifies the serial that the fixed asset references.This attribute is read-only.
• SynchronizationStatusCode: string
  Maximum Length: 30

  Value that identifies the status captured while enabling and tracking the synchronization.
• TagNumber: string
  Title: Tag Number

  Read Only: true

  Maximum Length: 15

  Value that contains user-defined tracking number that uniquely identifies the fixed asset.This attribute is read-only.
• 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.
• Units: number
  Read Only: true

  Value that contains number of units for the fixed asset.This attribute is read-only.
• ValidatedFlag: string
  Maximum Length: 1

  Value that identifies the association is valid and is eligible for synchronization between the two systems.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "AttributeCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Descriptive flexfield value for the fixed asset category.This attribute is read-only.",
            "nullable":false,
            "readOnly":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
        },
        "Description":{
            "title":"Description",
            "maxLength":80,
            "type":"string",
            "description":"Description of the fixed asset.This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that contains the errors encountered during the synchronization.",
            "nullable":true,
            "x-queryable":true
        },
        "FaAssetType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of the fixed asset.This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FaAssociationId":{
            "type":"integer",
            "description":"Number that uniquely identifies the fixed asset association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FaBookTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Contains a value of the asset book on which the fixed asset is part of.",
            "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
        },
        "FixedAssetNumber":{
            "title":"Fixed Asset Number",
            "maxLength":255,
            "type":"string",
            "description":"Number that uniquely identifies the fixed asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":35,
            "type":"string",
            "description":"Number that uniquely identifies the serial that the fixed asset references.This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SynchronizationStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the status captured while enabling and tracking the synchronization.",
            "nullable":true,
            "x-queryable":true
        },
        "TagNumber":{
            "title":"Tag Number",
            "maxLength":15,
            "type":"string",
            "description":"Value that contains user-defined tracking number that uniquely identifies the fixed asset.This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "Units":{
            "type":"number",
            "description":"Value that contains number of units for the fixed asset.This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidatedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the association is valid and is eligible for synchronization between the two systems.",
            "nullable":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