Jump to

• Request
• Response

Update an option

patch

/fscmRestApi/resources/11.13.18.05/maintenanceOrganizationRelationships/{OrganizationRelationshipId}

Request

Path Parameters

• OrganizationRelationshipId(required): integer(int64)
  Value that uniquely identifies the organization relationships.

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

• MaintenanceOrganizationCode: string
  Maximum Length: 255

  Value that identifies the maintenance organization.
• RelatedOrganizationCode: string
  Maximum Length: 255

  Value that identifies the organization that is related to the maintenance organization.
• RelationshipTypeCode: string
  Title: Relationship

  Maximum Length: 30

  Value that identifies the organization relationship type.

{
    "type":"object",
    "properties":{
        "MaintenanceOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the maintenance organization.",
            "nullable":true
        },
        "RelatedOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the organization that is related to the maintenance organization.",
            "nullable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the organization relationship type.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintenanceEnabledFlag: boolean
  Read Only: true

  Maximum Length: 255

  Value that uniquely identifies the maintenance organization is enabled.
• MaintenanceOrganizationCode: string
  Maximum Length: 255

  Value that identifies the maintenance organization.
• MaintenanceOrganizationId: integer (int64)
  Value that uniquely identifies the maintenance organization.
• MaintenanceOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the maintenance organization for which the organization relationship is established.
• OrganizationRelationshipId: integer (int64)
  Value that uniquely identifies the organization relationships.
• RelatedOrganizationCode: string
  Maximum Length: 255

  Value that identifies the organization that is related to the maintenance organization.
• RelatedOrganizationId: integer (int64)
  Value that uniquely identifies the organization that is related to the maintenance organization.
• RelatedOrganizationName: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the organization that is related to the maintenance organization.
• RelationshipType: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the relationship type by which the maintenance organization and the related organization are connected.
• RelationshipTypeCode: string
  Title: Relationship

  Maximum Length: 30

  Value that identifies the organization relationship type.

{
    "type":"object",
    "properties":{
        "MaintenanceEnabledFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that uniquely identifies the maintenance organization is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaintenanceOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the maintenance organization.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the maintenance organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaintenanceOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the maintenance organization for which the organization relationship is established.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationRelationshipId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization relationships.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelatedOrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the organization that is related to the maintenance organization.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that is related to the maintenance organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedOrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization that is related to the maintenance organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the relationship type by which the maintenance organization and the related organization are connected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the organization relationship type.",
            "nullable":false,
            "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