Work | Family Failure Typification

Service to manage entities of type 'FamilyFailureTypification'.

This service extends Families.

Overview

URL	api/{tenantKey}/{orgKey}/maintenanceCore/familyFailureTypifications
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET FamilyFailureTypifications (odata)
  • GET FamilyFailureTypification by identifier
  • GET FamilyFailureTypification by key
  • GET FamilyFailureTypifications (with Family)
  • GET FamilyFailureTypifications (with Family) (paged)
  • GET FamilyFailureTypification (with Family) by identifier
  • GET FamilyFailureTypification (with Family) by key
• POST:
  • POST FamilyFailureTypifications
  • POST FamilyFailureTypifications (with ApiBaseFamilyFailureTypification)
  • POST Family Failure Typification Line
• PUT:
  • PUT Set Custom Attribute FamilyFailureTypification
  • PUT Set Custom Attribute FamilyFailureTypificationLine
  • PUT Set IsActive FamilyFailureTypification
  • PUT Set FailureSymptom FamilyFailureTypificationLine
  • PUT Set FailureAction FamilyFailureTypificationLine
  • PUT Set FailureCause FamilyFailureTypificationLine
• DELETE:
  • DELETE Family Failure Typification Line by identifier
  • DELETE FamilyFailureTypification by identifier
  • DELETE FamilyFailureTypification by key

All Resources

This service uses the following resources:

• ApiBaseFamilyFailureTypificationFamilyFailureTypificationLinesResource
• ApiBaseFamilyFailureTypificationResource
• ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource
• ApiFamilyFailureTypificationResource
• BaseFamilyFailureTypificationFamilyFailureTypificationLinesResource
• BaseFamilyFailureTypificationResource
• FamilyFailureTypificationResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET FamilyFailureTypifications (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See FamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET FamilyFailureTypification by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See FamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET FamilyFailureTypification by key

Returns the entity record that matches the specified key.

The following elements are required:

familyKey

(string) The key for the part assortment.

Response:

When successful, the response body contains the entity record. See FamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET FamilyFailureTypifications (with Family)

Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.

Response:

When successful, the response body contains the list of records available. See BaseFamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET FamilyFailureTypifications (with Family) (paged)

Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See BaseFamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET FamilyFailureTypification (with Family) by identifier

Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See BaseFamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET FamilyFailureTypification (with Family) by key

Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.

The following elements are required:

familyKey

(string) The key for the part assortment.

Response:

When successful, the response body contains the entity record. See BaseFamilyFailureTypificationResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST FamilyFailureTypifications

Creates a new entity record.

The following elements are required:

familyFailureTypificationResource

(ApiFamilyFailureTypificationResource) The request body should contain the entity record that should be created. See ApiFamilyFailureTypificationResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiFamilyFailureTypificationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST FamilyFailureTypifications (with ApiBaseFamilyFailureTypification)

Creates a new entity record. The record shoud contain both data from the entity and the base entity.

The following elements are required:

familyFailureTypificationResource

(ApiFamilyFailureTypificationResource) The request body should contain the entity record that should be created. See ApiFamilyFailureTypificationResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiBaseFamilyFailureTypificationResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Family Failure Typification Line

Inserts a new 'Family Failure Typification Line' in the 'Family Failure Typification'.

The following elements are required:

familyKey	(string) The key for the part assortment.
value	(ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource) The ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource instance. See ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set FailureAction FamilyFailureTypificationLine

Updates the value of attribute 'FailureAction' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set FailureCause FamilyFailureTypificationLine

Updates the value of attribute 'FailureCause' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set FailureSymptom FamilyFailureTypificationLine

Updates the value of attribute 'FailureSymptom' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive FamilyFailureTypification

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Custom Attribute FamilyFailureTypification

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set Custom Attribute FamilyFailureTypificationLine

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

familyKey	(string) The key for the part assortment.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE Family Failure Typification Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

familyKey	(string) The key for the part assortment.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE FamilyFailureTypification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE FamilyFailureTypification by key

Deletes the entity record that matches the specified key.

The following elements are required:

familyKey

(string) The key for the part assortment.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiBaseFamilyFailureTypificationFamilyFailureTypificationLinesResource

The following elements are required:

failureSymptom	(string) Failure Symptom.
failureAction	(string) Failure Action.
failureCause	(string) Failure Cause.

ApiBaseFamilyFailureTypificationResource

The following elements are required:

familyKey	(string) The key for the part assortment.
description	(string) The description for the part assortment.
isExternallyManaged	(bool) A flag indicating if the part assortment is externally managed.
fromApi	(bool) From Api.

The following elements are optional:

familyFailureTypificationLines	(List of ApiBaseFamilyFailureTypificationFamilyFailureTypificationLinesResource) Failure Typifications. See ApiBaseFamilyFailureTypificationFamilyFailureTypificationLinesResource.
externalId	(string) The part assortment's external identifier.
externalVersion	(string) The part assortment's external version.
remarks	(string) The remarks for the part assortment.
parentFamily	(string) Parent Family.

ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource

The following elements are required:

failureSymptom	(string) Failure Symptom.
failureAction	(string) Failure Action.
failureCause	(string) Failure Cause.

ApiFamilyFailureTypificationResource

The following elements are required:

familyKey

(string) The key for the part assortment.

The following elements are optional:

familyFailureTypificationLines

(List of ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource) Failure Typifications. See ApiFamilyFailureTypificationFamilyFailureTypificationLinesResource.

BaseFamilyFailureTypificationFamilyFailureTypificationLinesResource

The following elements are required:

failureSymptom	(string) Failure Symptom.
failureAction	(string) Failure Action.
failureCause	(string) Failure Cause.

BaseFamilyFailureTypificationResource

The following elements are required:

familyKey	(string) The key for the part assortment.
description	(string) The description for the part assortment.
isExternallyManaged	(bool) A flag indicating if the part assortment is externally managed.
fromApi	(bool) From Api.

The following elements are optional:

familyFailureTypificationLines	(List of BaseFamilyFailureTypificationFamilyFailureTypificationLinesResource) Failure Typifications. See BaseFamilyFailureTypificationFamilyFailureTypificationLinesResource.
externalId	(string) The part assortment's external identifier.
externalVersion	(string) The part assortment's external version.
remarks	(string) The remarks for the part assortment.
parentFamily	(string) Parent Family.

FamilyFailureTypificationResource

The following elements are required:

familyKey

(string) The key for the part assortment.

The following elements are optional:

familyFailureTypificationLines

(List of FamilyFailureTypificationLineResource) Failure Typifications. See FamilyFailureTypificationLineResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.