Jump to

• Request
• Response
• Examples

Get one repair time

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyStandardRepairTimes/{WarrantyStandardRepairTimeId}

Request

Path Parameters

• WarrantyStandardRepairTimeId(required): integer(int64)
  Value that uniquely identifies the warranty repair time. The application creates this value when it creates the repair time.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : assetWarrantyStandardRepairTimes-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date on which the row was created.
• EndDate: string (date-time)
  Title: Active to Date

  End date of the warranty repair time. This attribute is optional.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time the row was most recently updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 255

  Name of the organization.
• OrganizationId: integer
  Title: Organization ID

  Abbreviation that uniquely identifies the organization.
• StandardOperationCode: string
  Title: Standard Operation Code

  Maximum Length: 255

  Abbreviation that uniquely identifies the standard operation. Either a standard operation ID or code is required.
• StandardOperationDescription: string
  Title: Standard Operation Description

  Read Only: true

  Maximum Length: 240

  Description of the standard operation. This is a read-only value.
• StandardOperationId: integer (int64)
  Title: Standard Operation ID

  Value that uniquely identifies the standard operation. Either a standard operation ID or code is required.
• StandardOperationName: string
  Title: Standard Operation Name

  Read Only: true

  Maximum Length: 120

  Name of the standard operation. This is a read-only value.
• StandardRepairTime: number
  Title: Standard Repair Time

  Value that identifies the number of labor hours for which the standard operation will be reimbursed in a warranty claim. This attribute is required.
• StartDate: string (date-time)
  Title: Active from Date

  Start date of the warranty repair time. This attribute is required.
• WarrantyProviderId: integer (int64)
  Title: Warranty Provider ID

  Value that uniquely identifies the warranty provider. Either a provider ID or a number is required.
• WarrantyProviderName: string
  Title: Warranty Provider Name

  Read Only: true

  Maximum Length: 360

  Name of the warranty provider. This is a read-only value.
• WarrantyProviderNumber: string
  Title: Warranty Provider Number

  Maximum Length: 255

  Value that uniquely identifies the supplier number of a warranty provider. Either a provider ID or a number is required.
• WarrantyStandardRepairTimeId: integer (int64)
  Title: Warranty Standard Repair Time ID

  Read Only: true

  Value that uniquely identifies the warranty repair time. The application creates this value when it creates the repair time.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date on which the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationCode":{
            "title":"Standard Operation Code",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the standard operation. Either a standard operation ID or code is required.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardOperationId":{
            "title":"Standard Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies the standard operation.  Either a standard operation ID or code is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the warranty provider. This is a read-only value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Abbreviation that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationId1"
                ]
            }
        },
        "EndDate":{
            "title":"Active to Date",
            "type":"string",
            "description":"End date of the warranty repair time. This attribute is optional.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the supplier number of a warranty provider. Either a provider ID or a number is required.",
            "nullable":true,
            "x-queryable":true
        },
        "StandardOperationName":{
            "title":"Standard Operation Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the standard operation. This is a read-only value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Active from Date",
            "type":"string",
            "description":"Start date of the warranty repair time. This attribute is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyStandardRepairTimeId":{
            "title":"Warranty Standard Repair Time ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty repair time. The application creates this value when it creates the repair time.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StandardOperationDescription":{
            "title":"Standard Operation Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the standard operation. This is a read-only value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":255,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StandardRepairTime":{
            "title":"Standard Repair Time",
            "type":"number",
            "description":"Value that identifies the number of labor hours for which the standard operation will be reimbursed in a warranty claim. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider. Either a provider ID or a number is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time the row was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "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 : 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

Examples

This example describes how to get one warranty repair time.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetWarrantyStandardRepairTimes/WarrantyStandardRepairTimeId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetWarrantyStandardRepairTimes/300100571254518"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"WarrantyStandardRepairTimeId": 300100571254518,
       "WarrantyProviderId": 999992000322153,
	"WarrantyProviderNumber": "123456789",
	"WarrantyProviderName": "Provider ABC",
	"StandardOperationId": 300100571252166,
	"StandardOperationCode": "STD_OP_CODE",
	"StandardOperationName": "Standard Operation",
	"StandardOperationDescription": "Standard Operation DESC",
	"StandardRepairTime": 2.5,
	"StartDate": "2021-03-31T00:00:00+00:00",
	"EndDate": "2023-12-31T00:00:00+00:00",
	"CreatedBy": "MNT_QA",
	"CreationDate": "2023-03-17T21:39:50+00:00",
	"LastUpdatedBy": "MNT_QA",
	"LastUpdateDate": "2023-03-17T21:39:50.001+00:00",
	"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/assetWarrantyStandardRepairTimes/300100582777055",
			"name": "assetWarrantyStandardRepairTimes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/assetWarrantyStandardRepairTimes/300100582777055",
			"name": "assetWarrantyStandardRepairTimes",
			"kind": "item"
		}
	]
}

Back to Top